knievel 0.1.35 → 0.1.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9094b3903beb762bf618d469866ae129d49968548dc93dd84cd0704dcf11dceb
-  data.tar.gz: 949ff589cdca45167d384b2968224cf9698074db0a4f07900ec407f7136d31be
+  metadata.gz: efa4ab4f7b59830b13bd18b0558e36697dccde6fd51ea51cad9dc39d901eac07
+  data.tar.gz: 4f206915dec8020b087bc3f1adac51f2facdfe42bae6fa4c48fd2acdeccf8fa6
 SHA512:
-  metadata.gz: 7f4d82a6736c05a43beea87b4c436bbfb8ec239d5086832cb79b86493706ba3933b2afb218c999b937f603890203cf07eb2383b8a3f1729f9286aef770e46a5f
-  data.tar.gz: 54b3a438deffe721bbe7eab445bcb8a0013a2d6341cd1b472f4e77c24cc14cfe6e551448edfed174a6129564b0e8a090c2f427c717ffa4e9b55572fc6ea722a9
+  metadata.gz: d3909aced7854b5c2530e15351c606b39b4017fedfa86b0f9356e7f5c1bb1766d7ca5806476f98fefb64563ef103c39e83e4ca212001925b57e4712fb6efce6a
+  data.tar.gz: 0a8e4540d26ba8dac770911f32fe7ef665ea9e7d44ca86ba174fb0afe9a6fa855b8bb13de114b5d754c6c23f428c909b6a65d12944c2c16edc349d336412515f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    knievel (0.1.35)
+    knievel (0.1.36)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart
       marcel

data/README.md

@@ -7,7 +7,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 0.1.31
-- Package version: 0.1.35
+- Package version: 0.1.36
 - Generator version: 7.23.0-SNAPSHOT
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -24,16 +24,16 @@ gem build knievel.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./knievel-0.1.35.gem
+gem install ./knievel-0.1.36.gem
 ```
 
-(for development, run `gem install --dev ./knievel-0.1.35.gem` to install the development dependencies)
+(for development, run `gem install --dev ./knievel-0.1.36.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'knievel', '~> 0.1.35'
+    gem 'knievel', '~> 0.1.36'
 
 ### Install from Git
 
@@ -205,6 +205,11 @@ Class | Method | HTTP request | Description
  - [Knievel::DecisionAd](docs/DecisionAd.md)
  - [Knievel::DecisionBlock](docs/DecisionBlock.md)
  - [Knievel::DecisionContext](docs/DecisionContext.md)
+ - [Knievel::DecisionCreative](docs/DecisionCreative.md)
+ - [Knievel::DecisionCreativeHtmlCreative](docs/DecisionCreativeHtmlCreative.md)
+ - [Knievel::DecisionCreativeImageCreative](docs/DecisionCreativeImageCreative.md)
+ - [Knievel::DecisionCreativeNativeCreative](docs/DecisionCreativeNativeCreative.md)
+ - [Knievel::DecisionCreativeTemplatedCreative](docs/DecisionCreativeTemplatedCreative.md)
  - [Knievel::DecisionPlacement](docs/DecisionPlacement.md)
  - [Knievel::DecisionsRequest](docs/DecisionsRequest.md)
  - [Knievel::DecisionsResponse](docs/DecisionsResponse.md)
@@ -217,7 +222,10 @@ Class | Method | HTTP request | Description
  - [Knievel::Flight](docs/Flight.md)
  - [Knievel::FlightList](docs/FlightList.md)
  - [Knievel::ForceOverride](docs/ForceOverride.md)
+ - [Knievel::HtmlCreative](docs/HtmlCreative.md)
+ - [Knievel::ImageCreative](docs/ImageCreative.md)
  - [Knievel::IssuerSummary](docs/IssuerSummary.md)
+ - [Knievel::NativeCreative](docs/NativeCreative.md)
  - [Knievel::OrgResponse](docs/OrgResponse.md)
  - [Knievel::Priority](docs/Priority.md)
  - [Knievel::PriorityList](docs/PriorityList.md)
@@ -225,6 +233,7 @@ Class | Method | HTTP request | Description
  - [Knievel::ProjectResponse](docs/ProjectResponse.md)
  - [Knievel::Site](docs/Site.md)
  - [Knievel::SiteList](docs/SiteList.md)
+ - [Knievel::TemplatedCreative](docs/TemplatedCreative.md)
  - [Knievel::TokenListResponse](docs/TokenListResponse.md)
  - [Knievel::TokenSummary](docs/TokenSummary.md)
  - [Knievel::UpdateAdLibraryItemRequest](docs/UpdateAdLibraryItemRequest.md)

data/docs/DecisionAd.md

@@ -13,6 +13,7 @@
 | **site_id** | **Integer** |  |  |
 | **click_url** | **String** |  |  |
 | **impression_url** | **String** |  |  |
+| **creative** | [**DecisionCreative**](DecisionCreative.md) | The selected ad's creative, typed by `kind` (`API.md` § 1 `oneOf`). `null` when the ad has no creative attached or the snapshot hasn't loaded it yet. For `templated` creatives the `body` is rendered server-side at decision time; the other kinds carry their stored fields verbatim. | [optional] |
 
 ## Example
 
@@ -28,7 +29,8 @@ instance = Knievel::DecisionAd.new(
   priority_id: null,
   site_id: null,
   click_url: null,
-  impression_url: null
+  impression_url: null,
+  creative: null
 )
 ```
 

data/docs/DecisionCreative.md

@@ -0,0 +1,34 @@
+# Knievel::DecisionCreative
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **image_url** | **String** |  | [optional] |
+| **width** | **Integer** |  | [optional] |
+| **height** | **Integer** |  | [optional] |
+| **alt** | **String** |  | [optional] |
+| **click_through_url** | **String** |  | [optional] |
+| **body** | **String** | The template's Liquid source rendered against `values` plus the injected decision context (signed URLs, placement id, snapshot version) at decision time. |  |
+| **template** | **String** | The referenced template's name. | [optional] |
+| **values** | **Object** | Echoed so callers can re-render or inspect. |  |
+
+## Example
+
+```ruby
+require 'knievel'
+
+instance = Knievel::DecisionCreative.new(
+  type: image,
+  image_url: null,
+  width: null,
+  height: null,
+  alt: null,
+  click_through_url: null,
+  body: null,
+  template: null,
+  values: null
+)
+```
+

data/docs/DecisionCreativeHtmlCreative.md

@@ -0,0 +1,22 @@
+# Knievel::DecisionCreativeHtmlCreative
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | Verbatim HTML stored on the creative, returned as-is. | [optional] |
+| **click_through_url** | **String** |  | [optional] |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'knievel'
+
+instance = Knievel::DecisionCreativeHtmlCreative.new(
+  body: null,
+  click_through_url: null,
+  type: html
+)
+```
+

data/docs/DecisionCreativeImageCreative.md

@@ -0,0 +1,28 @@
+# Knievel::DecisionCreativeImageCreative
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image_url** | **String** |  | [optional] |
+| **width** | **Integer** |  | [optional] |
+| **height** | **Integer** |  | [optional] |
+| **alt** | **String** |  | [optional] |
+| **click_through_url** | **String** |  | [optional] |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'knievel'
+
+instance = Knievel::DecisionCreativeImageCreative.new(
+  image_url: null,
+  width: null,
+  height: null,
+  alt: null,
+  click_through_url: null,
+  type: image
+)
+```
+

data/docs/DecisionCreativeNativeCreative.md

@@ -0,0 +1,24 @@
+# Knievel::DecisionCreativeNativeCreative
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template** | **String** | The referenced template's name; the caller renders `values` client-side using its own components. | [optional] |
+| **values** | **Object** |  |  |
+| **click_through_url** | **String** |  | [optional] |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'knievel'
+
+instance = Knievel::DecisionCreativeNativeCreative.new(
+  template: null,
+  values: null,
+  click_through_url: null,
+  type: native
+)
+```
+

data/docs/DecisionCreativeTemplatedCreative.md

@@ -0,0 +1,26 @@
+# Knievel::DecisionCreativeTemplatedCreative
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template** | **String** | The referenced template's name. | [optional] |
+| **values** | **Object** | Echoed so callers can re-render or inspect. |  |
+| **body** | **String** | The template's Liquid source rendered against `values` plus the injected decision context (signed URLs, placement id, snapshot version) at decision time. |  |
+| **click_through_url** | **String** |  | [optional] |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'knievel'
+
+instance = Knievel::DecisionCreativeTemplatedCreative.new(
+  template: null,
+  values: null,
+  body: null,
+  click_through_url: null,
+  type: templated
+)
+```
+

data/docs/HtmlCreative.md

@@ -0,0 +1,20 @@
+# Knievel::HtmlCreative
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | Verbatim HTML stored on the creative, returned as-is. | [optional] |
+| **click_through_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'knievel'
+
+instance = Knievel::HtmlCreative.new(
+  body: null,
+  click_through_url: null
+)
+```
+

data/docs/ImageCreative.md

@@ -0,0 +1,26 @@
+# Knievel::ImageCreative
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image_url** | **String** |  | [optional] |
+| **width** | **Integer** |  | [optional] |
+| **height** | **Integer** |  | [optional] |
+| **alt** | **String** |  | [optional] |
+| **click_through_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'knievel'
+
+instance = Knievel::ImageCreative.new(
+  image_url: null,
+  width: null,
+  height: null,
+  alt: null,
+  click_through_url: null
+)
+```
+

data/docs/NativeCreative.md

@@ -0,0 +1,22 @@
+# Knievel::NativeCreative
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template** | **String** | The referenced template's name; the caller renders `values` client-side using its own components. | [optional] |
+| **values** | **Object** |  |  |
+| **click_through_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'knievel'
+
+instance = Knievel::NativeCreative.new(
+  template: null,
+  values: null,
+  click_through_url: null
+)
+```
+

data/docs/TemplatedCreative.md

@@ -0,0 +1,24 @@
+# Knievel::TemplatedCreative
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template** | **String** | The referenced template's name. | [optional] |
+| **values** | **Object** | Echoed so callers can re-render or inspect. |  |
+| **body** | **String** | The template's Liquid source rendered against `values` plus the injected decision context (signed URLs, placement id, snapshot version) at decision time. |  |
+| **click_through_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'knievel'
+
+instance = Knievel::TemplatedCreative.new(
+  template: null,
+  values: null,
+  body: null,
+  click_through_url: null
+)
+```
+

data/lib/knievel/models/decision_ad.rb

@@ -33,6 +33,9 @@ module Knievel
 
     attr_accessor :impression_url
 
+    # The selected ad's creative, typed by `kind` (`API.md` § 1 `oneOf`). `null` when the ad has no creative attached or the snapshot hasn't loaded it yet. For `templated` creatives the `body` is rendered server-side at decision time; the other kinds carry their stored fields verbatim.
+    attr_accessor :creative
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -44,7 +47,8 @@ module Knievel
         :'priority_id' => :'priority_id',
         :'site_id' => :'site_id',
         :'click_url' => :'click_url',
-        :'impression_url' => :'impression_url'
+        :'impression_url' => :'impression_url',
+        :'creative' => :'creative'
       }
     end
 
@@ -69,7 +73,8 @@ module Knievel
         :'priority_id' => :'Integer',
         :'site_id' => :'Integer',
         :'click_url' => :'String',
-        :'impression_url' => :'String'
+        :'impression_url' => :'String',
+        :'creative' => :'DecisionCreative'
       }
     end
 
@@ -148,6 +153,10 @@ module Knievel
       else
         self.impression_url = nil
       end
+
+      if attributes.key?(:'creative')
+        self.creative = attributes[:'creative']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -313,7 +322,8 @@ module Knievel
           priority_id == o.priority_id &&
           site_id == o.site_id &&
           click_url == o.click_url &&
-          impression_url == o.impression_url
+          impression_url == o.impression_url &&
+          creative == o.creative
     end
 
     # @see the `==` method
@@ -325,7 +335,7 @@ module Knievel
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ad_id, creative_id, flight_id, campaign_id, advertiser_id, priority_id, site_id, click_url, impression_url].hash
+      [ad_id, creative_id, flight_id, campaign_id, advertiser_id, priority_id, site_id, click_url, impression_url, creative].hash
     end
 
     # Builds the object from hash

data/lib/knievel/models/decision_creative.rb

@@ -0,0 +1,106 @@
+=begin
+#knievel
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 0.1.31
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module Knievel
+  # The decision response's typed creative block — a discriminated union on `type` mirroring `API.md` § 1 / § 3.5. The four arms match the four creative `kind`s.
+  module DecisionCreative
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'DecisionCreativeHtmlCreative',
+          :'DecisionCreativeImageCreative',
+          :'DecisionCreativeNativeCreative',
+          :'DecisionCreativeTemplatedCreative'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = Knievel.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end