late-sdk 0.0.612 → 0.0.614

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

@@ -31,9 +31,12 @@ module Zernio
     # Breakdown dimension used (only present when breakdown was requested)
     attr_accessor :breakdown
 
-    # Object keyed by metric name. For time_series: each metric has \"total\" (number) and \"values\" (array of {date, value}). For total_value: each metric has \"total\" (number) and optionally \"breakdowns\" (array of {dimension, value}). 
+    # Object keyed by metric name. For time_series: each metric has \"total\" (number) and \"values\" (array of {date, value}). For total_value: each metric has \"total\" (number) and optionally \"breakdowns\" (array of {dimension, value}).  Monetary metrics additionally carry \"unit\" and \"currency\". Zernio never rescales money: \"total\" and every \"values[].value\" are the platform's raw numbers in the stated unit. Monetary metrics also keep \"values\" on metricType=total_value, because their \"total\" is the sum of the daily buckets the platform returned over the range: keep the series so you can reconcile that sum against the platform's own reporting before invoicing on it. A metric that could not be served is absent from this object and listed in \"unavailableMetrics\" instead, so an unavailable metric is never reported as a zero. 
     attr_accessor :metrics
 
+    # Requested metrics that could not be served. Present only when at least one metric is unavailable, and absent otherwise. Each listed metric is OMITTED from \"metrics\" rather than reported as 0, which is how an unavailable metric is distinguished from a genuine zero. The request itself still succeeds with HTTP 200. 
+    attr_accessor :unavailable_metrics
+
     attr_accessor :data_delay
 
     class EnumAttributeValidator
@@ -68,6 +71,7 @@ module Zernio
         :'metric_type' => :'metricType',
         :'breakdown' => :'breakdown',
         :'metrics' => :'metrics',
+        :'unavailable_metrics' => :'unavailableMetrics',
         :'data_delay' => :'dataDelay'
       }
     end
@@ -92,6 +96,7 @@ module Zernio
         :'metric_type' => :'String',
         :'breakdown' => :'String',
         :'metrics' => :'Hash<String, InstagramAccountInsightsResponseMetricsValue>',
+        :'unavailable_metrics' => :'Array<InstagramAccountInsightsResponseUnavailableMetricsInner>',
         :'data_delay' => :'String'
       }
     end
@@ -148,6 +153,12 @@ module Zernio
         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
@@ -204,6 +215,7 @@ module Zernio
           metric_type == o.metric_type &&
           breakdown == o.breakdown &&
           metrics == o.metrics &&
+          unavailable_metrics == o.unavailable_metrics &&
           data_delay == o.data_delay
     end
 
@@ -216,7 +228,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [success, account_id, platform, date_range, metric_type, breakdown, metrics, data_delay].hash
+      [success, account_id, platform, date_range, metric_type, breakdown, metrics, unavailable_metrics, data_delay].hash
     end
 
     # Builds the object from hash

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

@@ -18,18 +18,48 @@ module Zernio
     # Sum or aggregate value for the metric
     attr_accessor :total
 
-    # Daily values (only for time_series)
+    # Daily values (for time_series, and always on monetary metrics)
     attr_accessor :values
 
     # Breakdown values (only for total_value with breakdown)
     attr_accessor :breakdowns
 
+    # Present on monetary metrics only. The scale of \"total\" and of every \"values[].value\", exactly as the platform returned them.  \"micro_amount\": the platform returned an object shape carrying a micro amount, and the values are that integer, summed, 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. On Facebook Page insights this is always content_monetization_earnings.  \"unspecified\": the platform returned a bare number with no unit metadata. It is passed through as-is; the platform does not state whether it is major or minor currency units. On Facebook Page insights this is always monetization_approximate_earnings. 
+    attr_accessor :unit
+
+    # ISO 4217 currency of a monetary metric, or null when the platform omitted it. Always null on monetization_approximate_earnings, which Meta returns as a bare number with no currency; 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',
         :'values' => :'values',
-        :'breakdowns' => :'breakdowns'
+        :'breakdowns' => :'breakdowns',
+        :'unit' => :'unit',
+        :'currency' => :'currency'
       }
     end
 
@@ -48,13 +78,16 @@ module Zernio
       {
         :'total' => :'Float',
         :'values' => :'Array<InstagramAccountInsightsResponseMetricsValueValuesInner>',
-        :'breakdowns' => :'Array<InstagramAccountInsightsResponseMetricsValueBreakdownsInner>'
+        :'breakdowns' => :'Array<InstagramAccountInsightsResponseMetricsValueBreakdownsInner>',
+        :'unit' => :'String',
+        :'currency' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'currency'
       ])
     end
 
@@ -89,6 +122,14 @@ module Zernio
           self.breakdowns = value
         end
       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?
@@ -103,9 +144,21 @@ module Zernio
     # @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)
@@ -113,7 +166,9 @@ module Zernio
       self.class == o.class &&
           total == o.total &&
           values == o.values &&
-          breakdowns == o.breakdowns
+          breakdowns == o.breakdowns &&
+          unit == o.unit &&
+          currency == o.currency
     end
 
     # @see the `==` method
@@ -125,7 +180,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [total, values, breakdowns].hash
+      [total, values, breakdowns, unit, currency].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,202 @@
+=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 InstagramAccountInsightsResponseUnavailableMetricsInner < ApiModelBase
+    # The requested metric name.
+    attr_accessor :metric
+
+    # \"not_enrolled\": the account is not enrolled in the program behind this metric. \"permission_missing\": the connected user lacks access to this metric. \"unsupported_metric\": the platform does not accept this metric name on the API version Zernio uses. \"no_data\": the platform returned no bucket for this metric over the requested range. \"unreadable_value\": the platform returned a value shape Zernio cannot read, so no total is reported. \"mixed_currency\": readable values disagree on currency or unit within the range. \"upstream_error\": any other platform failure.  \"no_data\" is the common case in practice. The others are defensive: \"not_enrolled\" and \"unsupported_metric\" in particular have not been observed on live Facebook traffic, since a non-enrolled Page returns zeros rather than an error and metric names are validated before any platform call. 
+    attr_accessor :reason
+
+    # Platform-provided explanation when available (access tokens redacted), otherwise Zernio copy.
+    attr_accessor :message
+
+    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
+      {
+        :'metric' => :'metric',
+        :'reason' => :'reason',
+        :'message' => :'message'
+      }
+    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
+      {
+        :'metric' => :'String',
+        :'reason' => :'String',
+        :'message' => :'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::InstagramAccountInsightsResponseUnavailableMetricsInner` 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::InstagramAccountInsightsResponseUnavailableMetricsInner`. 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?(:'metric')
+        self.metric = attributes[:'metric']
+      end
+
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      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'
+      reason_validator = EnumAttributeValidator.new('String', ["not_enrolled", "permission_missing", "unsupported_metric", "no_data", "unreadable_value", "mixed_currency", "upstream_error"])
+      return false unless reason_validator.valid?(@reason)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] reason Object to be assigned
+    def reason=(reason)
+      validator = EnumAttributeValidator.new('String', ["not_enrolled", "permission_missing", "unsupported_metric", "no_data", "unreadable_value", "mixed_currency", "upstream_error"])
+      unless validator.valid?(reason)
+        fail ArgumentError, "invalid value for \"reason\", must be one of #{validator.allowable_values}."
+      end
+      @reason = reason
+    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 &&
+          metric == o.metric &&
+          reason == o.reason &&
+          message == o.message
+    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
+      [metric, reason, message].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/linked_in_ads_platform_data_thought_leader.rb

@@ -14,9 +14,9 @@ require 'date'
 require 'time'
 
 module Zernio
-  # POST /v1/ads/create only. Thought-leader ad: references someone else's existing LinkedIn share or ugcPost as the creative. Unlike boostPost, which provisions its own CampaignGroup + Campaign around the post, this variant attaches the reference under the campaign /v1/ads/create builds — same shape as every other format, so the caller can pick bidding / targeting / schedule freely. No headline, body, imageUrl or organization are needed; the referenced post carries its own commentary and author. Mutually exclusive with the other creative sources. 
+  # POST /v1/ads/create only. Sponsors an existing LinkedIn post (a share or ugcPost authored by your organization's Company Page) as the creative, keeping its commentary, author and engagement. Unlike boostPost, which provisions its own CampaignGroup + Campaign around the post, this variant attaches the reference under the campaign /v1/ads/create builds — same shape as every other format, so the caller can pick bidding / targeting / schedule freely. No headline, body, imageUrl or organization are needed; the referenced post carries its own commentary and author. Mutually exclusive with the other creative sources. Posts from personal profiles (Thought Leader Ads) are NOT supported (see postUrn). 
   class LinkedInAdsPlatformDataThoughtLeader < ApiModelBase
-    # LinkedIn share or ugcPost URN, urn:li:share:N or urn:li:ugcPost:N. Get it via \"Copy link to post\" on the target LinkedIn post (the URL contains -share- for a share or -ugcPost- for a ugcPost, then the numeric id). For member (personal profile) posts, LinkedIn's API only accepts video and document posts (ugcPost URNs); text and image member posts (share URNs) are rejected by LinkedIn regardless of sponsorship approval (a LinkedIn API limitation; those can only be sponsored from Campaign Manager). The member must have authorised sponsorship for the ad account's organization. 
+    # LinkedIn share or ugcPost URN, urn:li:share:N or urn:li:ugcPost:N. Get it via \"Copy link to post\" on the target LinkedIn post (the URL contains -share- for a share or -ugcPost- for a ugcPost, then the numeric id). The post must be authored by an organization (Company Page). Member (personal profile) posts, i.e. Thought Leader Ads proper, are rejected by LinkedIn's public Marketing API regardless of sponsorship approval and of post type (a LinkedIn limitation; their Campaign Manager creates those through a private API). Referencing a member post returns a 422 with a clear error. 
     attr_accessor :post_urn
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/zernio-sdk/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.19.0
 =end
 
 module Zernio
-  VERSION = '0.0.612'
+  VERSION = '0.0.614'
 end

data/lib/zernio-sdk.rb

@@ -392,6 +392,9 @@ require 'zernio-sdk/models/external_post_summary_analytics'
 require 'zernio-sdk/models/external_post_webhook_post'
 require 'zernio-sdk/models/facebook_platform_data'
 require 'zernio-sdk/models/facebook_platform_data_carousel_cards_inner'
+require 'zernio-sdk/models/facebook_post_earnings_response'
+require 'zernio-sdk/models/facebook_post_earnings_response_metrics_value'
+require 'zernio-sdk/models/facebook_post_earnings_response_unavailable_metrics_inner'
 require 'zernio-sdk/models/fetch_google_business_verification_options200_response'
 require 'zernio-sdk/models/fetch_google_business_verification_options200_response_options_inner'
 require 'zernio-sdk/models/fetch_google_business_verification_options_request'
@@ -761,6 +764,7 @@ require 'zernio-sdk/models/instagram_account_insights_response_date_range'
 require 'zernio-sdk/models/instagram_account_insights_response_metrics_value'
 require 'zernio-sdk/models/instagram_account_insights_response_metrics_value_breakdowns_inner'
 require 'zernio-sdk/models/instagram_account_insights_response_metrics_value_values_inner'
+require 'zernio-sdk/models/instagram_account_insights_response_unavailable_metrics_inner'
 require 'zernio-sdk/models/instagram_demographics_response'
 require 'zernio-sdk/models/instagram_demographics_response_demographics_value_inner'
 require 'zernio-sdk/models/instagram_platform_data'