plainrouter-sdk 0.2.0 → 0.5.0

data/lib/plainrouter/openapi/models/ad_test_show_read.rb

@@ -0,0 +1,164 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  class AdTestShowRead < ApiModelBase
+    attr_accessor :test
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'test' => :'test'
+      }
+    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
+      {
+        :'test' => :'AdTestCreateReadTest'
+      }
+    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 `PlainRouter::OpenAPI::AdTestShowRead` 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 `PlainRouter::OpenAPI::AdTestShowRead`. 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?(:'test')
+        self.test = attributes[:'test']
+      else
+        self.test = 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 @test.nil?
+        invalid_properties.push('invalid value for "test", test 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 @test.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] test Value to be assigned
+    def test=(test)
+      if test.nil?
+        fail ArgumentError, 'test cannot be nil'
+      end
+
+      @test = test
+    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 &&
+          test == o.test
+    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
+      [test].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/plainrouter/openapi/models/ad_test_verdict_member_read.rb

@@ -0,0 +1,349 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  class AdTestVerdictMemberRead < ApiModelBase
+    attr_accessor :ad_id
+
+    attr_accessor :state
+
+    attr_accessor :rank
+
+    attr_accessor :spend
+
+    attr_accessor :impressions
+
+    attr_accessor :counted_arrivals
+
+    # PlainRouter recorded consented conversions of this Test event.
+    attr_accessor :recorded_conversions
+
+    # Admitted conversions are shown beside recorded conversions and are never substituted for them.
+    attr_accessor :admitted_conversions
+
+    # Major-unit spend divided by PlainRouter recorded conversions; used only to compare members within this Test.
+    attr_accessor :spend_per_recorded_conversion
+
+    attr_accessor :covered_days
+
+    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
+      {
+        :'ad_id' => :'ad_id',
+        :'state' => :'state',
+        :'rank' => :'rank',
+        :'spend' => :'spend',
+        :'impressions' => :'impressions',
+        :'counted_arrivals' => :'counted_arrivals',
+        :'recorded_conversions' => :'recorded_conversions',
+        :'admitted_conversions' => :'admitted_conversions',
+        :'spend_per_recorded_conversion' => :'spend_per_recorded_conversion',
+        :'covered_days' => :'covered_days'
+      }
+    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
+      {
+        :'ad_id' => :'String',
+        :'state' => :'String',
+        :'rank' => :'Integer',
+        :'spend' => :'String',
+        :'impressions' => :'Integer',
+        :'counted_arrivals' => :'Integer',
+        :'recorded_conversions' => :'Integer',
+        :'admitted_conversions' => :'Integer',
+        :'spend_per_recorded_conversion' => :'String',
+        :'covered_days' => :'Array<Date>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'rank',
+        :'spend',
+        :'impressions',
+        :'counted_arrivals',
+        :'recorded_conversions',
+        :'admitted_conversions',
+        :'spend_per_recorded_conversion',
+      ])
+    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 `PlainRouter::OpenAPI::AdTestVerdictMemberRead` 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 `PlainRouter::OpenAPI::AdTestVerdictMemberRead`. 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?(:'ad_id')
+        self.ad_id = attributes[:'ad_id']
+      else
+        self.ad_id = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'rank')
+        self.rank = attributes[:'rank']
+      else
+        self.rank = nil
+      end
+
+      if attributes.key?(:'spend')
+        self.spend = attributes[:'spend']
+      else
+        self.spend = nil
+      end
+
+      if attributes.key?(:'impressions')
+        self.impressions = attributes[:'impressions']
+      else
+        self.impressions = nil
+      end
+
+      if attributes.key?(:'counted_arrivals')
+        self.counted_arrivals = attributes[:'counted_arrivals']
+      else
+        self.counted_arrivals = nil
+      end
+
+      if attributes.key?(:'recorded_conversions')
+        self.recorded_conversions = attributes[:'recorded_conversions']
+      else
+        self.recorded_conversions = nil
+      end
+
+      if attributes.key?(:'admitted_conversions')
+        self.admitted_conversions = attributes[:'admitted_conversions']
+      else
+        self.admitted_conversions = nil
+      end
+
+      if attributes.key?(:'spend_per_recorded_conversion')
+        self.spend_per_recorded_conversion = attributes[:'spend_per_recorded_conversion']
+      else
+        self.spend_per_recorded_conversion = nil
+      end
+
+      if attributes.key?(:'covered_days')
+        if (value = attributes[:'covered_days']).is_a?(Array)
+          self.covered_days = value
+        end
+      else
+        self.covered_days = 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 @ad_id.nil?
+        invalid_properties.push('invalid value for "ad_id", ad_id cannot be nil.')
+      end
+
+      if @ad_id.to_s.length > 128
+        invalid_properties.push('invalid value for "ad_id", the character length must be smaller than or equal to 128.')
+      end
+
+      pattern = Regexp.new(/^[0-9]+$/)
+      if @ad_id !~ pattern
+        invalid_properties.push("invalid value for \"ad_id\", must conform to the pattern #{pattern}.")
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @covered_days.nil?
+        invalid_properties.push('invalid value for "covered_days", covered_days 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 @ad_id.nil?
+      return false if @ad_id.to_s.length > 128
+      return false if @ad_id !~ Regexp.new(/^[0-9]+$/)
+      return false if @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ["not_delivered", "insufficient", "ranked", "facts_unavailable", "halted"])
+      return false unless state_validator.valid?(@state)
+      return false if @covered_days.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ad_id Value to be assigned
+    def ad_id=(ad_id)
+      if ad_id.nil?
+        fail ArgumentError, 'ad_id cannot be nil'
+      end
+
+      if ad_id.to_s.length > 128
+        fail ArgumentError, 'invalid value for "ad_id", the character length must be smaller than or equal to 128.'
+      end
+
+      pattern = Regexp.new(/^[0-9]+$/)
+      if ad_id !~ pattern
+        fail ArgumentError, "invalid value for \"ad_id\", must conform to the pattern #{pattern}."
+      end
+
+      @ad_id = ad_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["not_delivered", "insufficient", "ranked", "facts_unavailable", "halted"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] covered_days Value to be assigned
+    def covered_days=(covered_days)
+      if covered_days.nil?
+        fail ArgumentError, 'covered_days cannot be nil'
+      end
+
+      @covered_days = covered_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 &&
+          ad_id == o.ad_id &&
+          state == o.state &&
+          rank == o.rank &&
+          spend == o.spend &&
+          impressions == o.impressions &&
+          counted_arrivals == o.counted_arrivals &&
+          recorded_conversions == o.recorded_conversions &&
+          admitted_conversions == o.admitted_conversions &&
+          spend_per_recorded_conversion == o.spend_per_recorded_conversion &&
+          covered_days == o.covered_days
+    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
+      [ad_id, state, rank, spend, impressions, counted_arrivals, recorded_conversions, admitted_conversions, spend_per_recorded_conversion, covered_days].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