late-sdk 0.0.613 → 0.0.615

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

@@ -37,6 +37,9 @@ module Zernio
     # Meta `effective_object_story_id` — `{pageId}_{postId}` of the Facebook post the ad's engagement (comments) lives on. Pass to GET /v1/ads?effectiveObjectStoryId= to map a Business-Manager-visible post back to this ad; GET /v1/ads/{adId}/comments resolves comments against it.
     attr_accessor :effective_object_story_id
 
+    # Facebook Page backing the creative (Meta only). What the `pageId` filter on /v1/ads, /v1/ads/campaigns and /v1/ads/tree matches against. Absent for non-Meta ads and rare Meta creatives with no page signal.
+    attr_accessor :page_id
+
     # Meta `effective_instagram_media_id` — the Instagram media ID of the boosted post the ad's engagement lives on. Pass to GET /v1/ads?effectiveInstagramMediaId= to map a Business-Manager-visible IG post back to this ad.
     attr_accessor :effective_instagram_media_id
 
@@ -77,6 +80,7 @@ module Zernio
         :'object_type' => :'objectType',
         :'object_story_id' => :'objectStoryId',
         :'effective_object_story_id' => :'effectiveObjectStoryId',
+        :'page_id' => :'pageId',
         :'effective_instagram_media_id' => :'effectiveInstagramMediaId',
         :'instagram_user_id' => :'instagramUserId',
         :'instagram_permalink_url' => :'instagramPermalinkUrl',
@@ -111,6 +115,7 @@ module Zernio
         :'object_type' => :'String',
         :'object_story_id' => :'String',
         :'effective_object_story_id' => :'String',
+        :'page_id' => :'String',
         :'effective_instagram_media_id' => :'String',
         :'instagram_user_id' => :'String',
         :'instagram_permalink_url' => :'String',
@@ -132,6 +137,7 @@ module Zernio
         :'video_url',
         :'object_story_id',
         :'effective_object_story_id',
+        :'page_id',
         :'effective_instagram_media_id',
         :'instagram_user_id',
         :'instagram_permalink_url',
@@ -182,6 +188,10 @@ module Zernio
         self.effective_object_story_id = attributes[:'effective_object_story_id']
       end
 
+      if attributes.key?(:'page_id')
+        self.page_id = attributes[:'page_id']
+      end
+
       if attributes.key?(:'effective_instagram_media_id')
         self.effective_instagram_media_id = attributes[:'effective_instagram_media_id']
       end
@@ -256,6 +266,7 @@ module Zernio
           object_type == o.object_type &&
           object_story_id == o.object_story_id &&
           effective_object_story_id == o.effective_object_story_id &&
+          page_id == o.page_id &&
           effective_instagram_media_id == o.effective_instagram_media_id &&
           instagram_user_id == o.instagram_user_id &&
           instagram_permalink_url == o.instagram_permalink_url &&
@@ -278,7 +289,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [thumbnail_url, image_url, video_id, video_url, object_type, object_story_id, effective_object_story_id, effective_instagram_media_id, instagram_user_id, instagram_permalink_url, media_urls, body, google_headline, google_description, link_url, pinterest_image_url, pinterest_title, pinterest_description].hash
+      [thumbnail_url, image_url, video_id, video_url, object_type, object_story_id, effective_object_story_id, page_id, effective_instagram_media_id, instagram_user_id, instagram_permalink_url, media_urls, body, google_headline, google_description, link_url, pinterest_image_url, pinterest_title, pinterest_description].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,253 @@
+=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
+  # Lifetime monetization earnings for one Facebook post. Same \"unit\" / \"currency\" contract and same unavailable-vs-zero contract as the Page-level response; there is no date range, no metricType, and no daily \"values\", because the single lifetime bucket IS the total. 
+  class FacebookPostEarningsResponse < ApiModelBase
+    attr_accessor :success
+
+    attr_accessor :account_id
+
+    # The platform post ID that was queried, echoed back.
+    attr_accessor :post_id
+
+    attr_accessor :platform
+
+    # Always \"lifetime\": the total is cumulative since publication and must not be summed across dates or across posts. 
+    attr_accessor :period
+
+    # One entry per served metric. A metric reported here with \"total\": 0 genuinely earned nothing (or its Page is not enrolled, which Meta reports identically). 
+    attr_accessor :metrics
+
+    # Requested metrics Meta could not serve. Present only when at least one metric is unavailable, and absent otherwise. Each listed metric is OMITTED from \"metrics\" rather than reported as 0. The request itself still succeeds with HTTP 200. 
+    attr_accessor :unavailable_metrics
+
+    attr_accessor :data_delay
+
+    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
+      {
+        :'success' => :'success',
+        :'account_id' => :'accountId',
+        :'post_id' => :'postId',
+        :'platform' => :'platform',
+        :'period' => :'period',
+        :'metrics' => :'metrics',
+        :'unavailable_metrics' => :'unavailableMetrics',
+        :'data_delay' => :'dataDelay'
+      }
+    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
+      {
+        :'success' => :'Boolean',
+        :'account_id' => :'String',
+        :'post_id' => :'String',
+        :'platform' => :'String',
+        :'period' => :'String',
+        :'metrics' => :'Hash<String, FacebookPostEarningsResponseMetricsValue>',
+        :'unavailable_metrics' => :'Array<FacebookPostEarningsResponseUnavailableMetricsInner>',
+        :'data_delay' => :'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::FacebookPostEarningsResponse` 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::FacebookPostEarningsResponse`. 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?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'post_id')
+        self.post_id = attributes[:'post_id']
+      end
+
+      if attributes.key?(:'platform')
+        self.platform = attributes[:'platform']
+      end
+
+      if attributes.key?(:'period')
+        self.period = attributes[:'period']
+      end
+
+      if attributes.key?(:'metrics')
+        if (value = attributes[:'metrics']).is_a?(Hash)
+          self.metrics = value
+        end
+      end
+
+      if attributes.key?(:'unavailable_metrics')
+        if (value = attributes[:'unavailable_metrics']).is_a?(Array)
+          self.unavailable_metrics = value
+        end
+      end
+
+      if attributes.key?(:'data_delay')
+        self.data_delay = attributes[:'data_delay']
+      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
+      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'
+      period_validator = EnumAttributeValidator.new('String', ["lifetime"])
+      return false unless period_validator.valid?(@period)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] period Object to be assigned
+    def period=(period)
+      validator = EnumAttributeValidator.new('String', ["lifetime"])
+      unless validator.valid?(period)
+        fail ArgumentError, "invalid value for \"period\", must be one of #{validator.allowable_values}."
+      end
+      @period = period
+    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 &&
+          success == o.success &&
+          account_id == o.account_id &&
+          post_id == o.post_id &&
+          platform == o.platform &&
+          period == o.period &&
+          metrics == o.metrics &&
+          unavailable_metrics == o.unavailable_metrics &&
+          data_delay == o.data_delay
+    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
+      [success, account_id, post_id, platform, period, metrics, unavailable_metrics, data_delay].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/facebook_post_earnings_response_metrics_value.rb

@@ -0,0 +1,203 @@
+=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
+  class FacebookPostEarningsResponseMetricsValue < ApiModelBase
+    # Lifetime earnings in \"unit\", exactly as Meta returned them. Never rescaled.
+    attr_accessor :total
+
+    # \"micro_amount\": Meta returned an object shape carrying a micro amount, and \"total\" is that integer, unconverted. Zernio does not publish a divisor because Meta does not document one; divide by the scale you have verified against the Page's own Meta Business Suite export. This is always content_monetization_earnings.  \"unspecified\": Meta returned a bare number with no unit metadata, passed through as-is; Meta does not state whether it is major or minor currency units. This is always monetization_approximate_earnings. 
+    attr_accessor :unit
+
+    # ISO 4217 currency, or null when Meta omitted it. Always null on monetization_approximate_earnings; always present on content_monetization_earnings. 
+    attr_accessor :currency
+
+    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
+      {
+        :'total' => :'total',
+        :'unit' => :'unit',
+        :'currency' => :'currency'
+      }
+    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
+      {
+        :'total' => :'Float',
+        :'unit' => :'String',
+        :'currency' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'currency'
+      ])
+    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::FacebookPostEarningsResponseMetricsValue` 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::FacebookPostEarningsResponseMetricsValue`. 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?(:'total')
+        self.total = attributes[:'total']
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      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
+      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'
+      unit_validator = EnumAttributeValidator.new('String', ["micro_amount", "unspecified"])
+      return false unless unit_validator.valid?(@unit)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] unit Object to be assigned
+    def unit=(unit)
+      validator = EnumAttributeValidator.new('String', ["micro_amount", "unspecified"])
+      unless validator.valid?(unit)
+        fail ArgumentError, "invalid value for \"unit\", must be one of #{validator.allowable_values}."
+      end
+      @unit = unit
+    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 &&
+          total == o.total &&
+          unit == o.unit &&
+          currency == o.currency
+    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
+      [total, unit, currency].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