adzerk_decision_sdk 1.0.0.pre.beta.1 → 1.0.0.pre.beta.6

data/lib/adzerk_decision_sdk/api_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 

data/lib/adzerk_decision_sdk/client.rb

@@ -36,8 +36,8 @@ module AdzerkDecisionSdk
       api_client.default_headers['X-Adzerk-Sdk-Version'] = "adzerk-decision-sdk-ruby:#{version}"
 
       @decisions = DecisionClient.new(network_id, site_id, api_client, configuration.logger)
-      @user_db = UserDbClient.new(network_id, api_client)
-      @pixels = PixelClient.new(api_client)
+      @user_db = UserDbClient.new(network_id, api_client, configuration.logger)
+      @pixels = PixelClient.new(api_client, configuration.logger)
     end
   end
 end

data/lib/adzerk_decision_sdk/configuration.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 

data/lib/adzerk_decision_sdk/decision_client.rb

@@ -2,11 +2,13 @@ require 'adzerk_decision_sdk/api/decision_api'
 
 module AdzerkDecisionSdk
   class DecisionClient
+
     def initialize(network_id, site_id, api_client, logger)
       @network_id = network_id
       @site_id = site_id
       @api = DecisionApi.new(api_client)
       @logger = logger
+      @deprecated_placement_fields = [[:ecpm_partition, 'ecpm_partitions']]
     end
 
     def get(request, opts = {})
@@ -18,14 +20,22 @@ module AdzerkDecisionSdk
 
       opts[:body][:enableBotFiltering] = false if not opts[:body].has_key?(:enableBotFiltering)
 
-      if !opts[:body].has_key?(:placements) or !opts[:body][:placements] or !opts[:body][:placements].length() == 0
+      if !opts[:body].has_key?(:placements) or !opts[:body][:placements] or opts[:body][:placements].length() == 0
         fail ArgumentError, "Each request requires at least one placement"
       end
 
       opts[:body][:placements].each_with_index do |placement, idx|
-        if !placement.has_key?(:adTypes) or !placements[:adTypes] or placement[:adTypes].length() == 0
+        if !placement.has_key?(:adTypes) or !placement[:adTypes] or placement[:adTypes].length() == 0
           fail ArgumentError, "Each placement needs at least one ad type"
         end
+
+        @deprecated_placement_fields.each do |pair|
+          deprecated_field, replacement = pair
+          if placement.has_key?(deprecated_field) and !placement[deprecated_field].nil?
+            @logger.warn("DEPRECATION WARNING: #{deprecated_field} has been deprecated. Please use #{replacement} instead.")
+          end
+        end
+
         placement[:networkId] = @network_id if not placement.has_key?(:networkId)
         placement[:siteId] = @site_id if not placement.has_key?(:siteId)
         placement[:divName] = "div#{idx}" if not placement.has_key?(:divName)
@@ -35,13 +45,13 @@ module AdzerkDecisionSdk
 
       if opts.has_key?(:include_explanation) and opts[:include_explanation] == true
         header_params['X-Adzerk-Explain'] = opts[:api_key]
-        @logger.info("--------------------------------------------------------------")
-        @logger.info("              !!! WARNING - WARNING - WARNING !!!             ")
-        @logger.info("")
-        @logger.info("You have opted to include explainer details with this request!")
-        @logger.info("This will cause performance degradation and should not be done")
-        @logger.info("in production environments.")
-        @logger.info("--------------------------------------------------------------")
+        @logger.warn("--------------------------------------------------------------")
+        @logger.warn("              !!! WARNING - WARNING - WARNING !!!             ")
+        @logger.warn("")
+        @logger.warn("You have opted to include explainer details with this request!")
+        @logger.warn("This will cause performance degradation and should not be done")
+        @logger.warn("in production environments.")
+        @logger.warn("--------------------------------------------------------------")
       end
 
       opts[:header_params] = header_params
@@ -50,9 +60,10 @@ module AdzerkDecisionSdk
       @logger.info("Requesting with headers: #{opts[:header_params]}")
 
       response = @api.get_decisions(opts)
+      @logger.info("Received response: #{response}")
 
       parsed_response = parse_response(response)
-      @logger.info("Recieved response: #{parsed_response}")
+      @logger.info("Parsed response: #{parsed_response}")
 
       return parsed_response
     end

data/lib/adzerk_decision_sdk/models/consent_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 

data/lib/adzerk_decision_sdk/models/content.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -41,7 +41,7 @@ module AdzerkDecisionSdk
         :'type' => :'String',
         :'template' => :'String',
         :'custom_template' => :'String',
-        :'data' => :'DecisionData',
+        :'data' => :'Object',
         :'body' => :'String'
       }
     end

data/lib/adzerk_decision_sdk/models/decision.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -32,6 +32,8 @@ module AdzerkDecisionSdk
 
     attr_accessor :events
 
+    attr_accessor :matched_points
+
     attr_accessor :pricing
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -46,6 +48,7 @@ module AdzerkDecisionSdk
         :'contents' => :'contents',
         :'impression_url' => :'impressionUrl',
         :'events' => :'events',
+        :'matched_points' => :'matchedPoints',
         :'pricing' => :'pricing'
       }
     end
@@ -62,6 +65,7 @@ module AdzerkDecisionSdk
         :'contents' => :'Array<Content>',
         :'impression_url' => :'String',
         :'events' => :'Array<Event>',
+        :'matched_points' => :'Array<MatchedPoint>',
         :'pricing' => :'PricingData'
       }
     end
@@ -127,6 +131,12 @@ module AdzerkDecisionSdk
         end
       end
 
+      if attributes.key?(:'matched_points')
+        if (value = attributes[:'matched_points']).is_a?(Array)
+          self.matched_points = value
+        end
+      end
+
       if attributes.key?(:'pricing')
         self.pricing = attributes[:'pricing']
       end
@@ -159,6 +169,7 @@ module AdzerkDecisionSdk
           contents == o.contents &&
           impression_url == o.impression_url &&
           events == o.events &&
+          matched_points == o.matched_points &&
           pricing == o.pricing
     end
 
@@ -171,7 +182,7 @@ module AdzerkDecisionSdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ad_id, creative_id, flight_id, campaign_id, priority_id, click_url, contents, impression_url, events, pricing].hash
+      [ad_id, creative_id, flight_id, campaign_id, priority_id, click_url, contents, impression_url, events, matched_points, pricing].hash
     end
 
     # Builds the object from hash

data/lib/adzerk_decision_sdk/models/decision_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -55,6 +55,14 @@ module AdzerkDecisionSdk
     # RTB requests only - sets an Identifier for Advertisers (IFA or IDFA)
     attr_accessor :device_id
 
+    attr_accessor :parallel
+
+    attr_accessor :intended_latitude
+
+    attr_accessor :intended_longitude
+
+    attr_accessor :include_matched_points
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -71,7 +79,11 @@ module AdzerkDecisionSdk
         :'enable_bot_filtering' => :'enableBotFiltering',
         :'enable_user_dbip' => :'enableUserDBIP',
         :'consent' => :'consent',
-        :'device_id' => :'deviceID'
+        :'device_id' => :'deviceID',
+        :'parallel' => :'parallel',
+        :'intended_latitude' => :'intendedLatitude',
+        :'intended_longitude' => :'intendedLongitude',
+        :'include_matched_points' => :'includeMatchedPoints'
       }
     end
 
@@ -91,7 +103,11 @@ module AdzerkDecisionSdk
         :'enable_bot_filtering' => :'Boolean',
         :'enable_user_dbip' => :'Boolean',
         :'consent' => :'Object',
-        :'device_id' => :'String'
+        :'device_id' => :'String',
+        :'parallel' => :'Boolean',
+        :'intended_latitude' => :'String',
+        :'intended_longitude' => :'String',
+        :'include_matched_points' => :'Boolean'
       }
     end
 
@@ -109,7 +125,11 @@ module AdzerkDecisionSdk
         :'enable_bot_filtering',
         :'enable_user_dbip',
         :'consent',
-        :'device_id'
+        :'device_id',
+        :'parallel',
+        :'intended_latitude',
+        :'intended_longitude',
+        :'include_matched_points'
       ])
     end
 
@@ -189,6 +209,22 @@ module AdzerkDecisionSdk
       if attributes.key?(:'device_id')
         self.device_id = attributes[:'device_id']
       end
+
+      if attributes.key?(:'parallel')
+        self.parallel = attributes[:'parallel']
+      end
+
+      if attributes.key?(:'intended_latitude')
+        self.intended_latitude = attributes[:'intended_latitude']
+      end
+
+      if attributes.key?(:'intended_longitude')
+        self.intended_longitude = attributes[:'intended_longitude']
+      end
+
+      if attributes.key?(:'include_matched_points')
+        self.include_matched_points = attributes[:'include_matched_points']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -227,7 +263,11 @@ module AdzerkDecisionSdk
           enable_bot_filtering == o.enable_bot_filtering &&
           enable_user_dbip == o.enable_user_dbip &&
           consent == o.consent &&
-          device_id == o.device_id
+          device_id == o.device_id &&
+          parallel == o.parallel &&
+          intended_latitude == o.intended_latitude &&
+          intended_longitude == o.intended_longitude &&
+          include_matched_points == o.include_matched_points
     end
 
     # @see the `==` method
@@ -239,7 +279,7 @@ module AdzerkDecisionSdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [placements, user, keywords, url, referrer, ip, blocked_creatives, is_mobile, include_pricing_data, notrack, enable_bot_filtering, enable_user_dbip, consent, device_id].hash
+      [placements, user, keywords, url, referrer, ip, blocked_creatives, is_mobile, include_pricing_data, notrack, enable_bot_filtering, enable_user_dbip, consent, device_id, parallel, intended_latitude, intended_longitude, include_matched_points].hash
     end
 
     # Builds the object from hash

data/lib/adzerk_decision_sdk/models/decision_response.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 

data/lib/adzerk_decision_sdk/models/event.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 

data/lib/adzerk_decision_sdk/models/{decision_data.rb → matched_point.rb}

@@ -6,43 +6,31 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 
 require 'date'
 
 module AdzerkDecisionSdk
-  class DecisionData
-    attr_accessor :image_url
+  class MatchedPoint
+    attr_accessor :lat
 
-    attr_accessor :title
-
-    attr_accessor :width
-
-    attr_accessor :height
-
-    attr_accessor :custom_data
+    attr_accessor :lon
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'image_url' => :'imageURL',
-        :'title' => :'title',
-        :'width' => :'width',
-        :'height' => :'height',
-        :'custom_data' => :'customData'
+        :'lat' => :'lat',
+        :'lon' => :'lon'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'image_url' => :'String',
-        :'title' => :'String',
-        :'width' => :'Integer',
-        :'height' => :'Integer',
-        :'custom_data' => :'Object'
+        :'lat' => :'String',
+        :'lon' => :'String'
       }
     end
 
@@ -56,35 +44,23 @@ module AdzerkDecisionSdk
     # @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 `AdzerkDecisionSdk::DecisionData` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AdzerkDecisionSdk::MatchedPoint` 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 `AdzerkDecisionSdk::DecisionData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AdzerkDecisionSdk::MatchedPoint`. 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?(:'image_url')
-        self.image_url = attributes[:'image_url']
-      end
-
-      if attributes.key?(:'title')
-        self.title = attributes[:'title']
-      end
-
-      if attributes.key?(:'width')
-        self.width = attributes[:'width']
-      end
-
-      if attributes.key?(:'height')
-        self.height = attributes[:'height']
+      if attributes.key?(:'lat')
+        self.lat = attributes[:'lat']
       end
 
-      if attributes.key?(:'custom_data')
-        self.custom_data = attributes[:'custom_data']
+      if attributes.key?(:'lon')
+        self.lon = attributes[:'lon']
       end
     end
 
@@ -106,11 +82,8 @@ module AdzerkDecisionSdk
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          image_url == o.image_url &&
-          title == o.title &&
-          width == o.width &&
-          height == o.height &&
-          custom_data == o.custom_data
+          lat == o.lat &&
+          lon == o.lon
     end
 
     # @see the `==` method
@@ -122,7 +95,7 @@ module AdzerkDecisionSdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [image_url, title, width, height, custom_data].hash
+      [lat, lon].hash
     end
 
     # Builds the object from hash

data/lib/adzerk_decision_sdk/models/placement.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -62,6 +62,15 @@ module AdzerkDecisionSdk
     # (BETA) The name of the eCPM Partition that should be used to source eCPM data for auctions
     attr_accessor :ecpm_partition
 
+    # (BETA) The names of the eCPM Partitions that should be used to source eCPM data for auctions
+    attr_accessor :ecpm_partitions
+
+    attr_accessor :event_multiplier
+
+    attr_accessor :skip_selection
+
+    attr_accessor :ad_query
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -80,7 +89,11 @@ module AdzerkDecisionSdk
         :'content_keys' => :'contentKeys',
         :'count' => :'count',
         :'proportionality' => :'proportionality',
-        :'ecpm_partition' => :'ecpmPartition'
+        :'ecpm_partition' => :'ecpmPartition',
+        :'ecpm_partitions' => :'ecpmPartitions',
+        :'event_multiplier' => :'eventMultiplier',
+        :'skip_selection' => :'skipSelection',
+        :'ad_query' => :'adQuery'
       }
     end
 
@@ -102,7 +115,11 @@ module AdzerkDecisionSdk
         :'content_keys' => :'Hash<String, Integer>',
         :'count' => :'Integer',
         :'proportionality' => :'Boolean',
-        :'ecpm_partition' => :'String'
+        :'ecpm_partition' => :'String',
+        :'ecpm_partitions' => :'Array<String>',
+        :'event_multiplier' => :'Integer',
+        :'skip_selection' => :'Boolean',
+        :'ad_query' => :'Object'
       }
     end
 
@@ -120,7 +137,11 @@ module AdzerkDecisionSdk
         :'content_keys',
         :'count',
         :'proportionality',
-        :'ecpm_partition'
+        :'ecpm_partition',
+        :'ecpm_partitions',
+        :'event_multiplier',
+        :'skip_selection',
+        :'ad_query'
       ])
     end
 
@@ -210,21 +231,63 @@ module AdzerkDecisionSdk
       if attributes.key?(:'ecpm_partition')
         self.ecpm_partition = attributes[:'ecpm_partition']
       end
+
+      if attributes.key?(:'ecpm_partitions')
+        if (value = attributes[:'ecpm_partitions']).is_a?(Array)
+          self.ecpm_partitions = value
+        end
+      end
+
+      if attributes.key?(:'event_multiplier')
+        self.event_multiplier = attributes[:'event_multiplier']
+      end
+
+      if attributes.key?(:'skip_selection')
+        self.skip_selection = attributes[:'skip_selection']
+      end
+
+      if attributes.key?(:'ad_query')
+        self.ad_query = attributes[:'ad_query']
+      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
       invalid_properties = Array.new
+      if !@event_multiplier.nil? && @event_multiplier > 100000000
+        invalid_properties.push('invalid value for "event_multiplier", must be smaller than or equal to 100000000.')
+      end
+
+      if !@event_multiplier.nil? && @event_multiplier < -100000000
+        invalid_properties.push('invalid value for "event_multiplier", must be greater than or equal to -100000000.')
+      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?
+      return false if !@event_multiplier.nil? && @event_multiplier > 100000000
+      return false if !@event_multiplier.nil? && @event_multiplier < -100000000
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] event_multiplier Value to be assigned
+    def event_multiplier=(event_multiplier)
+      if !event_multiplier.nil? && event_multiplier > 100000000
+        fail ArgumentError, 'invalid value for "event_multiplier", must be smaller than or equal to 100000000.'
+      end
+
+      if !event_multiplier.nil? && event_multiplier < -100000000
+        fail ArgumentError, 'invalid value for "event_multiplier", must be greater than or equal to -100000000.'
+      end
+
+      @event_multiplier = event_multiplier
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -245,7 +308,11 @@ module AdzerkDecisionSdk
           content_keys == o.content_keys &&
           count == o.count &&
           proportionality == o.proportionality &&
-          ecpm_partition == o.ecpm_partition
+          ecpm_partition == o.ecpm_partition &&
+          ecpm_partitions == o.ecpm_partitions &&
+          event_multiplier == o.event_multiplier &&
+          skip_selection == o.skip_selection &&
+          ad_query == o.ad_query
     end
 
     # @see the `==` method
@@ -257,7 +324,7 @@ module AdzerkDecisionSdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [div_name, network_id, site_id, ad_types, zone_ids, campaign_id, flight_id, ad_id, click_url, properties, event_ids, overrides, content_keys, count, proportionality, ecpm_partition].hash
+      [div_name, network_id, site_id, ad_types, zone_ids, campaign_id, flight_id, ad_id, click_url, properties, event_ids, overrides, content_keys, count, proportionality, ecpm_partition, ecpm_partitions, event_multiplier, skip_selection, ad_query].hash
     end
 
     # Builds the object from hash