norbelys 0.1.0

data/lib/norbelys/models/program_step_input.rb

@@ -0,0 +1,469 @@
+=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 ProgramStepInput
+    # Minimum sends before a winner can be decided.
+    attr_accessor :ab_min_sample
+
+    # How the A/B winner is decided: manual, even, ai_percentage.
+    attr_accessor :ab_mode
+
+    # Percent of leads in the test group while the A/B test holds.
+    attr_accessor :ab_test_pct
+
+    # Metric the winner is decided by: reply, positive_reply, click, open.
+    attr_accessor :ab_winning_metric
+
+    # Send channel for this step; defaults to `email`.
+    attr_accessor :channel
+
+    # Position in the cadence (0-based); defaults to array order.
+    attr_accessor :order_idx
+
+    # Days to wait after the previous step before this one sends.
+    attr_accessor :wait_days
+
+    attr_accessor :ab_winner_variant_id
+
+    # Set true (with id) to archive this step.
+    attr_accessor :archived
+
+    # Existing step id to edit; omit to create a new step.
+    attr_accessor :id
+
+    # The step's arms — one for a plain step, several for an A/B test.
+    attr_accessor :variants
+
+    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
+      {
+        :'ab_min_sample' => :'abMinSample',
+        :'ab_mode' => :'abMode',
+        :'ab_test_pct' => :'abTestPct',
+        :'ab_winning_metric' => :'abWinningMetric',
+        :'channel' => :'channel',
+        :'order_idx' => :'orderIdx',
+        :'wait_days' => :'waitDays',
+        :'ab_winner_variant_id' => :'abWinnerVariantId',
+        :'archived' => :'archived',
+        :'id' => :'id',
+        :'variants' => :'variants'
+      }
+    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
+      {
+        :'ab_min_sample' => :'Integer',
+        :'ab_mode' => :'String',
+        :'ab_test_pct' => :'Integer',
+        :'ab_winning_metric' => :'String',
+        :'channel' => :'String',
+        :'order_idx' => :'Integer',
+        :'wait_days' => :'Integer',
+        :'ab_winner_variant_id' => :'String',
+        :'archived' => :'Boolean',
+        :'id' => :'String',
+        :'variants' => :'Array<ProgramVariantInput>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'ab_winner_variant_id',
+      ])
+    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::ProgramStepInput` 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::ProgramStepInput`. 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?(:'ab_min_sample')
+        self.ab_min_sample = attributes[:'ab_min_sample']
+      end
+
+      if attributes.key?(:'ab_mode')
+        self.ab_mode = attributes[:'ab_mode']
+      end
+
+      if attributes.key?(:'ab_test_pct')
+        self.ab_test_pct = attributes[:'ab_test_pct']
+      end
+
+      if attributes.key?(:'ab_winning_metric')
+        self.ab_winning_metric = attributes[:'ab_winning_metric']
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
+
+      if attributes.key?(:'order_idx')
+        self.order_idx = attributes[:'order_idx']
+      end
+
+      if attributes.key?(:'wait_days')
+        self.wait_days = attributes[:'wait_days']
+      end
+
+      if attributes.key?(:'ab_winner_variant_id')
+        self.ab_winner_variant_id = attributes[:'ab_winner_variant_id']
+      end
+
+      if attributes.key?(:'archived')
+        self.archived = attributes[:'archived']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'variants')
+        if (value = attributes[:'variants']).is_a?(Array)
+          self.variants = 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 !@ab_min_sample.nil? && @ab_min_sample < 1
+        invalid_properties.push('invalid value for "ab_min_sample", must be greater than or equal to 1.')
+      end
+
+      if !@ab_test_pct.nil? && @ab_test_pct > 100
+        invalid_properties.push('invalid value for "ab_test_pct", must be smaller than or equal to 100.')
+      end
+
+      if !@ab_test_pct.nil? && @ab_test_pct < 0
+        invalid_properties.push('invalid value for "ab_test_pct", must be greater than or equal to 0.')
+      end
+
+      if !@order_idx.nil? && @order_idx < 0
+        invalid_properties.push('invalid value for "order_idx", must be greater than or equal to 0.')
+      end
+
+      if !@wait_days.nil? && @wait_days > 365
+        invalid_properties.push('invalid value for "wait_days", must be smaller than or equal to 365.')
+      end
+
+      if !@wait_days.nil? && @wait_days < 0
+        invalid_properties.push('invalid value for "wait_days", 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 !@ab_min_sample.nil? && @ab_min_sample < 1
+      ab_mode_validator = EnumAttributeValidator.new('String', ["manual", "even", "ai_percentage"])
+      return false unless ab_mode_validator.valid?(@ab_mode)
+      return false if !@ab_test_pct.nil? && @ab_test_pct > 100
+      return false if !@ab_test_pct.nil? && @ab_test_pct < 0
+      ab_winning_metric_validator = EnumAttributeValidator.new('String', ["reply", "positive_reply", "click", "open"])
+      return false unless ab_winning_metric_validator.valid?(@ab_winning_metric)
+      channel_validator = EnumAttributeValidator.new('String', ["email", "call", "sms", "linkedin"])
+      return false unless channel_validator.valid?(@channel)
+      return false if !@order_idx.nil? && @order_idx < 0
+      return false if !@wait_days.nil? && @wait_days > 365
+      return false if !@wait_days.nil? && @wait_days < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ab_min_sample Value to be assigned
+    def ab_min_sample=(ab_min_sample)
+      if ab_min_sample.nil?
+        fail ArgumentError, 'ab_min_sample cannot be nil'
+      end
+
+      if ab_min_sample < 1
+        fail ArgumentError, 'invalid value for "ab_min_sample", must be greater than or equal to 1.'
+      end
+
+      @ab_min_sample = ab_min_sample
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] ab_mode Object to be assigned
+    def ab_mode=(ab_mode)
+      validator = EnumAttributeValidator.new('String', ["manual", "even", "ai_percentage"])
+      unless validator.valid?(ab_mode)
+        fail ArgumentError, "invalid value for \"ab_mode\", must be one of #{validator.allowable_values}."
+      end
+      @ab_mode = ab_mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ab_test_pct Value to be assigned
+    def ab_test_pct=(ab_test_pct)
+      if ab_test_pct.nil?
+        fail ArgumentError, 'ab_test_pct cannot be nil'
+      end
+
+      if ab_test_pct > 100
+        fail ArgumentError, 'invalid value for "ab_test_pct", must be smaller than or equal to 100.'
+      end
+
+      if ab_test_pct < 0
+        fail ArgumentError, 'invalid value for "ab_test_pct", must be greater than or equal to 0.'
+      end
+
+      @ab_test_pct = ab_test_pct
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] ab_winning_metric Object to be assigned
+    def ab_winning_metric=(ab_winning_metric)
+      validator = EnumAttributeValidator.new('String', ["reply", "positive_reply", "click", "open"])
+      unless validator.valid?(ab_winning_metric)
+        fail ArgumentError, "invalid value for \"ab_winning_metric\", must be one of #{validator.allowable_values}."
+      end
+      @ab_winning_metric = ab_winning_metric
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] channel Object to be assigned
+    def channel=(channel)
+      validator = EnumAttributeValidator.new('String', ["email", "call", "sms", "linkedin"])
+      unless validator.valid?(channel)
+        fail ArgumentError, "invalid value for \"channel\", must be one of #{validator.allowable_values}."
+      end
+      @channel = channel
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] order_idx Value to be assigned
+    def order_idx=(order_idx)
+      if order_idx.nil?
+        fail ArgumentError, 'order_idx cannot be nil'
+      end
+
+      if order_idx < 0
+        fail ArgumentError, 'invalid value for "order_idx", must be greater than or equal to 0.'
+      end
+
+      @order_idx = order_idx
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] wait_days Value to be assigned
+    def wait_days=(wait_days)
+      if wait_days.nil?
+        fail ArgumentError, 'wait_days cannot be nil'
+      end
+
+      if wait_days > 365
+        fail ArgumentError, 'invalid value for "wait_days", must be smaller than or equal to 365.'
+      end
+
+      if wait_days < 0
+        fail ArgumentError, 'invalid value for "wait_days", must be greater than or equal to 0.'
+      end
+
+      @wait_days = wait_days
+    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 &&
+          ab_min_sample == o.ab_min_sample &&
+          ab_mode == o.ab_mode &&
+          ab_test_pct == o.ab_test_pct &&
+          ab_winning_metric == o.ab_winning_metric &&
+          channel == o.channel &&
+          order_idx == o.order_idx &&
+          wait_days == o.wait_days &&
+          ab_winner_variant_id == o.ab_winner_variant_id &&
+          archived == o.archived &&
+          id == o.id &&
+          variants == o.variants
+    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
+      [ab_min_sample, ab_mode, ab_test_pct, ab_winning_metric, channel, order_idx, wait_days, ab_winner_variant_id, archived, id, variants].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