late-sdk 0.0.658 → 0.0.659

data/lib/zernio-sdk/models/value_rule.rb

@@ -0,0 +1,346 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  # One bid-adjustment rule. Rules are evaluated in ARRAY ORDER and only the first matching rule adjusts the bid for an overlapping audience, so the order is semantic. 
+  class ValueRule < ApiModelBase
+    # Platform rule id. Echo it on `PUT` to KEEP this rule, omit it to CREATE a new one. A rule left out of the array entirely is DELETED. 
+    attr_accessor :id
+
+    attr_accessor :name
+
+    # Direction of the adjustment. There is no signed value field.
+    attr_accessor :adjust_sign
+
+    # Unsigned percentage magnitude. `INCREASE` accepts 1-1000, `DECREASE` accepts 1-90. 0 is out of range on both. 
+    attr_accessor :adjust_value
+
+    # Meta returns `ACTIVE` here but documents no enum for the field. Treat it as a passthrough: echo whatever the `GET` returned, and do not synthesize values. 
+    attr_accessor :status
+
+    # All criteria on a rule must match for the rule to fire.
+    attr_accessor :criteria
+
+    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
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'adjust_sign' => :'adjustSign',
+        :'adjust_value' => :'adjustValue',
+        :'status' => :'status',
+        :'criteria' => :'criteria'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'adjust_sign' => :'String',
+        :'adjust_value' => :'Integer',
+        :'status' => :'String',
+        :'criteria' => :'Array<ValueRuleCriterion>'
+      }
+    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 `Zernio::ValueRule` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::ValueRule`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'adjust_sign')
+        self.adjust_sign = attributes[:'adjust_sign']
+      else
+        self.adjust_sign = nil
+      end
+
+      if attributes.key?(:'adjust_value')
+        self.adjust_value = attributes[:'adjust_value']
+      else
+        self.adjust_value = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'criteria')
+        if (value = attributes[:'criteria']).is_a?(Array)
+          self.criteria = value
+        end
+      else
+        self.criteria = 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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 255
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
+      end
+
+      if @adjust_sign.nil?
+        invalid_properties.push('invalid value for "adjust_sign", adjust_sign cannot be nil.')
+      end
+
+      if @adjust_value.nil?
+        invalid_properties.push('invalid value for "adjust_value", adjust_value cannot be nil.')
+      end
+
+      if @adjust_value > 1000
+        invalid_properties.push('invalid value for "adjust_value", must be smaller than or equal to 1000.')
+      end
+
+      if @adjust_value < 1
+        invalid_properties.push('invalid value for "adjust_value", must be greater than or equal to 1.')
+      end
+
+      if @criteria.nil?
+        invalid_properties.push('invalid value for "criteria", criteria cannot be nil.')
+      end
+
+      if @criteria.length > 4
+        invalid_properties.push('invalid value for "criteria", number of items must be less than or equal to 4.')
+      end
+
+      if @criteria.length < 1
+        invalid_properties.push('invalid value for "criteria", number of items must be greater than or equal to 1.')
+      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 @name.nil?
+      return false if @name.to_s.length > 255
+      return false if @name.to_s.length < 1
+      return false if @adjust_sign.nil?
+      adjust_sign_validator = EnumAttributeValidator.new('String', ["INCREASE", "DECREASE"])
+      return false unless adjust_sign_validator.valid?(@adjust_sign)
+      return false if @adjust_value.nil?
+      return false if @adjust_value > 1000
+      return false if @adjust_value < 1
+      return false if @criteria.nil?
+      return false if @criteria.length > 4
+      return false if @criteria.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] adjust_sign Object to be assigned
+    def adjust_sign=(adjust_sign)
+      validator = EnumAttributeValidator.new('String', ["INCREASE", "DECREASE"])
+      unless validator.valid?(adjust_sign)
+        fail ArgumentError, "invalid value for \"adjust_sign\", must be one of #{validator.allowable_values}."
+      end
+      @adjust_sign = adjust_sign
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] adjust_value Value to be assigned
+    def adjust_value=(adjust_value)
+      if adjust_value.nil?
+        fail ArgumentError, 'adjust_value cannot be nil'
+      end
+
+      if adjust_value > 1000
+        fail ArgumentError, 'invalid value for "adjust_value", must be smaller than or equal to 1000.'
+      end
+
+      if adjust_value < 1
+        fail ArgumentError, 'invalid value for "adjust_value", must be greater than or equal to 1.'
+      end
+
+      @adjust_value = adjust_value
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] criteria Value to be assigned
+    def criteria=(criteria)
+      if criteria.nil?
+        fail ArgumentError, 'criteria cannot be nil'
+      end
+
+      if criteria.length > 4
+        fail ArgumentError, 'invalid value for "criteria", number of items must be less than or equal to 4.'
+      end
+
+      if criteria.length < 1
+        fail ArgumentError, 'invalid value for "criteria", number of items must be greater than or equal to 1.'
+      end
+
+      @criteria = criteria
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          adjust_sign == o.adjust_sign &&
+          adjust_value == o.adjust_value &&
+          status == o.status &&
+          criteria == o.criteria
+    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
+      [id, name, adjust_sign, adjust_value, status, criteria].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
+
+    # 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
+
+  end
+
+end

data/lib/zernio-sdk/models/value_rule_criterion.rb

@@ -0,0 +1,305 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  # One matching condition inside a value rule. `criteriaValues` and `criteriaValueTypes` are POSITIONALLY paired: same length, same order. 
+  class ValueRuleCriterion < ApiModelBase
+    # Platform criterion id. Echo it on `PUT` to KEEP this criterion, omit it to CREATE a new one. A criterion left out of the array entirely is DELETED. 
+    attr_accessor :id
+
+    # The dimension being matched. `OMNI_CHANNEL` (conversion location: APP, INSTANT_FORM, PHONE_CALL, WEBSITE) is accepted even though Meta's own enum table omits it. 
+    attr_accessor :criteria_type
+
+    # Required on every criterion. `CONTAINS` is currently the only value Meta supports.
+    attr_accessor :operator
+
+    # The values to match. `AGE` takes ranges such as `18-24`, `18+` or a custom `18-26`; a range whose upper bound is 65 is NOT allowed (use `18+` instead of `18-65`). `LOCATION` takes Targeting-Search keys: a two-letter country code for `LOCATION_COUNTRY`, a numeric key for region / city / comScore market. `AUDIENCE_LABEL` takes labels such as `HIGH_VALUE`, which are applied to a Custom Audience in Ads Manager: there is no API to provision them, so they are passed through unvalidated. 
+    attr_accessor :criteria_values
+
+    # One entry per `criteriaValues` entry, in the same order. The literal `\"NONE\"` for every criteriaType except `LOCATION`, which uses `LOCATION_COUNTRY`, `LOCATION_REGION`, `LOCATION_CITY` or `LOCATION_COMSCORE_MARKET` and MAY mix them within one criterion. `LOCATION_DMA` was replaced by `LOCATION_COMSCORE_MARKET` on 2026-06-22 and is rejected by this API. 
+    attr_accessor :criteria_value_types
+
+    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
+      {
+        :'id' => :'id',
+        :'criteria_type' => :'criteriaType',
+        :'operator' => :'operator',
+        :'criteria_values' => :'criteriaValues',
+        :'criteria_value_types' => :'criteriaValueTypes'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'criteria_type' => :'String',
+        :'operator' => :'String',
+        :'criteria_values' => :'Array<String>',
+        :'criteria_value_types' => :'Array<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 `Zernio::ValueRuleCriterion` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::ValueRuleCriterion`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'criteria_type')
+        self.criteria_type = attributes[:'criteria_type']
+      else
+        self.criteria_type = nil
+      end
+
+      if attributes.key?(:'operator')
+        self.operator = attributes[:'operator']
+      else
+        self.operator = nil
+      end
+
+      if attributes.key?(:'criteria_values')
+        if (value = attributes[:'criteria_values']).is_a?(Array)
+          self.criteria_values = value
+        end
+      else
+        self.criteria_values = nil
+      end
+
+      if attributes.key?(:'criteria_value_types')
+        if (value = attributes[:'criteria_value_types']).is_a?(Array)
+          self.criteria_value_types = value
+        end
+      else
+        self.criteria_value_types = 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 @criteria_type.nil?
+        invalid_properties.push('invalid value for "criteria_type", criteria_type cannot be nil.')
+      end
+
+      if @operator.nil?
+        invalid_properties.push('invalid value for "operator", operator cannot be nil.')
+      end
+
+      if @criteria_values.nil?
+        invalid_properties.push('invalid value for "criteria_values", criteria_values cannot be nil.')
+      end
+
+      if @criteria_values.length < 1
+        invalid_properties.push('invalid value for "criteria_values", number of items must be greater than or equal to 1.')
+      end
+
+      if @criteria_value_types.nil?
+        invalid_properties.push('invalid value for "criteria_value_types", criteria_value_types cannot be nil.')
+      end
+
+      if @criteria_value_types.length < 1
+        invalid_properties.push('invalid value for "criteria_value_types", number of items must be greater than or equal to 1.')
+      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 @criteria_type.nil?
+      criteria_type_validator = EnumAttributeValidator.new('String', ["AGE", "GENDER", "OS_TYPE", "DEVICE_PLATFORM", "LOCATION", "PLACEMENT", "OMNI_CHANNEL", "AUDIENCE_LABEL"])
+      return false unless criteria_type_validator.valid?(@criteria_type)
+      return false if @operator.nil?
+      operator_validator = EnumAttributeValidator.new('String', ["CONTAINS"])
+      return false unless operator_validator.valid?(@operator)
+      return false if @criteria_values.nil?
+      return false if @criteria_values.length < 1
+      return false if @criteria_value_types.nil?
+      return false if @criteria_value_types.length < 1
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] criteria_type Object to be assigned
+    def criteria_type=(criteria_type)
+      validator = EnumAttributeValidator.new('String', ["AGE", "GENDER", "OS_TYPE", "DEVICE_PLATFORM", "LOCATION", "PLACEMENT", "OMNI_CHANNEL", "AUDIENCE_LABEL"])
+      unless validator.valid?(criteria_type)
+        fail ArgumentError, "invalid value for \"criteria_type\", must be one of #{validator.allowable_values}."
+      end
+      @criteria_type = criteria_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] operator Object to be assigned
+    def operator=(operator)
+      validator = EnumAttributeValidator.new('String', ["CONTAINS"])
+      unless validator.valid?(operator)
+        fail ArgumentError, "invalid value for \"operator\", must be one of #{validator.allowable_values}."
+      end
+      @operator = operator
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] criteria_values Value to be assigned
+    def criteria_values=(criteria_values)
+      if criteria_values.nil?
+        fail ArgumentError, 'criteria_values cannot be nil'
+      end
+
+      if criteria_values.length < 1
+        fail ArgumentError, 'invalid value for "criteria_values", number of items must be greater than or equal to 1.'
+      end
+
+      @criteria_values = criteria_values
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] criteria_value_types Value to be assigned
+    def criteria_value_types=(criteria_value_types)
+      if criteria_value_types.nil?
+        fail ArgumentError, 'criteria_value_types cannot be nil'
+      end
+
+      if criteria_value_types.length < 1
+        fail ArgumentError, 'invalid value for "criteria_value_types", number of items must be greater than or equal to 1.'
+      end
+
+      @criteria_value_types = criteria_value_types
+    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 &&
+          id == o.id &&
+          criteria_type == o.criteria_type &&
+          operator == o.operator &&
+          criteria_values == o.criteria_values &&
+          criteria_value_types == o.criteria_value_types
+    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
+      [id, criteria_type, operator, criteria_values, criteria_value_types].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
+
+    # 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
+
+  end
+
+end