late-sdk 0.0.897 → 0.0.899

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

@@ -22,6 +22,9 @@ module Zernio
     # Messaging and CTWA only. Raw Facebook pageId_postId reference, used as object_story_id even with an Instagram account. Mutually exclusive with existingPostId and fresh creative fields.
     attr_accessor :object_story_id
 
+    # Replaces the top-level creativeFeatures map for this item. Omit to inherit; an empty object clears inherited enrollment choices.
+    attr_accessor :creative_features
+
     attr_accessor :headline
 
     # Primary text shown above the image / video.
@@ -34,11 +37,34 @@ module Zernio
 
     attr_accessor :welcome_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
       {
         :'existing_post_id' => :'existingPostId',
         :'object_story_id' => :'objectStoryId',
+        :'creative_features' => :'creativeFeatures',
         :'headline' => :'headline',
         :'body' => :'body',
         :'image_url' => :'imageUrl',
@@ -62,6 +88,7 @@ module Zernio
       {
         :'existing_post_id' => :'String',
         :'object_story_id' => :'String',
+        :'creative_features' => :'Hash<String, String>',
         :'headline' => :'String',
         :'body' => :'String',
         :'image_url' => :'String',
@@ -100,6 +127,12 @@ module Zernio
         self.object_story_id = attributes[:'object_story_id']
       end
 
+      if attributes.key?(:'creative_features')
+        if (value = attributes[:'creative_features']).is_a?(Hash)
+          self.creative_features = value
+        end
+      end
+
       if attributes.key?(:'headline')
         self.headline = attributes[:'headline']
       end
@@ -230,6 +263,7 @@ module Zernio
       self.class == o.class &&
           existing_post_id == o.existing_post_id &&
           object_story_id == o.object_story_id &&
+          creative_features == o.creative_features &&
           headline == o.headline &&
           body == o.body &&
           image_url == o.image_url &&
@@ -246,7 +280,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [existing_post_id, object_story_id, headline, body, image_url, video, welcome_message].hash
+      [existing_post_id, object_story_id, creative_features, headline, body, image_url, video, welcome_message].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,275 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api  Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal.  Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema). 
+
+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
+  # Meta explicit Promotion offer. Maps to creative_sourcing_spec.promotion_metadata_spec with promotion_source ADVERTISER_INPUT. Dates become Unix seconds. Send null to omit an explicit offer on a new creative or remove it when rebuilding. Creation success alone does not confirm application: inspect promotionStatus in the response.
+  class MetaPromotion < ApiModelBase
+    # Promotion type accepted by Meta. PERCENTAGE_OFF values cannot exceed 100.
+    attr_accessor :type
+
+    # Nonnegative promotion value passed to Meta unchanged. AMOUNT_OFF units are not confirmed, including major versus minor currency units. For PERCENTAGE_OFF this is the percentage discount, at most 100.
+    attr_accessor :value
+
+    # Optional promotion code.
+    attr_accessor :code
+
+    # Optional ISO 8601 start timestamp with a timezone offset or Z.
+    attr_accessor :start_date
+
+    # Optional ISO 8601 end timestamp with a timezone offset or Z. Must be after startDate when both are set.
+    attr_accessor :end_date
+
+    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
+      {
+        :'type' => :'type',
+        :'value' => :'value',
+        :'code' => :'code',
+        :'start_date' => :'startDate',
+        :'end_date' => :'endDate'
+      }
+    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
+      {
+        :'type' => :'String',
+        :'value' => :'Float',
+        :'code' => :'String',
+        :'start_date' => :'Time',
+        :'end_date' => :'Time'
+      }
+    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::MetaPromotion` 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::MetaPromotion`. 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?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      else
+        self.value = nil
+      end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @value.nil?
+        invalid_properties.push('invalid value for "value", value cannot be nil.')
+      end
+
+      if @value < 0
+        invalid_properties.push('invalid value for "value", must be greater than or equal to 0.')
+      end
+
+      if !@code.nil? && @code.to_s.length < 1
+        invalid_properties.push('invalid value for "code", the character length must be greater than or equal to 1.')
+      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 @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["AMOUNT_OFF", "FREE_RETURN", "FREE_SHIPPING", "PERCENTAGE_OFF", "PROMO_CODE"])
+      return false unless type_validator.valid?(@type)
+      return false if @value.nil?
+      return false if @value < 0
+      return false if !@code.nil? && @code.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["AMOUNT_OFF", "FREE_RETURN", "FREE_SHIPPING", "PERCENTAGE_OFF", "PROMO_CODE"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] value Value to be assigned
+    def value=(value)
+      if value.nil?
+        fail ArgumentError, 'value cannot be nil'
+      end
+
+      if value < 0
+        fail ArgumentError, 'invalid value for "value", must be greater than or equal to 0.'
+      end
+
+      @value = value
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] code Value to be assigned
+    def code=(code)
+      if code.nil?
+        fail ArgumentError, 'code cannot be nil'
+      end
+
+      if code.to_s.length < 1
+        fail ArgumentError, 'invalid value for "code", the character length must be greater than or equal to 1.'
+      end
+
+      @code = code
+    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 &&
+          type == o.type &&
+          value == o.value &&
+          code == o.code &&
+          start_date == o.start_date &&
+          end_date == o.end_date
+    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
+      [type, value, code, start_date, end_date].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/meta_promotion_status.rb

@@ -0,0 +1,41 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api  Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal.  Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema). 
+
+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 MetaPromotionStatus
+    APPLIED = "applied".freeze
+    NOT_RETURNED = "not_returned".freeze
+    UNAVAILABLE = "unavailable".freeze
+
+    def self.all_vars
+      @all_vars ||= [APPLIED, NOT_RETURNED, UNAVAILABLE].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if MetaPromotionStatus.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #MetaPromotionStatus"
+    end
+  end
+end

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

@@ -14,8 +14,13 @@ require 'date'
 require 'time'
 
 module Zernio
-  # Replace or patch the ad's creative. Meta, TikTok, and LinkedIn.  - **Meta**: patch-style. Pass any subset: fields you omit are preserved from the   live creative, including media (`image_hash`/`video_id` are reused, no re-upload)   and `url_tags`. Sending the full set (`headline`, `body`, `callToAction`,   `linkUrl`, `imageUrl`) rebuilds the creative from scratch instead. Partial   patching reads the live `object_story_spec`, which Meta strips on SHARE /   page-post / dark / asset_feed creatives. Those return 422 asking for the full   set. A `videoUrl`/`videoId` on an image creative is a type change and also   needs the full set. `existingCreativeId` repoints the ad at a creative from   GET /v1/ads/creatives and ignores every other field. Meta creatives are   immutable, so any change creates a new creative and repoints the ad; the old   creative is retained on the ad account for historical reporting. - **TikTok**: patch-style. Pass any subset; `headline` is ignored (TikTok creatives   have no headline slot). `body` becomes the in-feed `ad_text`; `linkUrl` becomes   `landing_page_url`; `videoUrl` triggers a fresh upload. `description`, `videoId`   and `existingCreativeId` are Meta-only and return 400. - **LinkedIn**: requires new media (image via `imageUrl` or video via `videoUrl`);   a text-only creative update returns 400. Uploads the media, creates a new inline   media creative on the same campaign, and pauses the old creative (best-effort).   The old creative is retained for historical reporting. `videoId` and   `existingCreativeId` are Meta-only and return 400. 
+  # Replace or patch the ad's creative. Meta, TikTok, and LinkedIn.  - **Meta**: patch-style. Pass any subset: fields you omit are preserved from the   live creative, including media (`image_hash`/`video_id` are reused, no re-upload)   and `url_tags`. Sending the full set (`headline`, `body`, `callToAction`,   `linkUrl`, `imageUrl`) rebuilds the creative from scratch instead. Partial   patching reads the live `object_story_spec`, which Meta strips on SHARE /   page-post / dark / asset_feed creatives. Those return 422 asking for the full   set. A `videoUrl`/`videoId` on an image creative is a type change and also   needs the full set. `existingCreativeId` repoints the ad at a creative from   GET /v1/ads/creatives and ignores every other field. Meta creatives are   immutable, so any change creates a new creative and repoints the ad; the old   creative is retained on the ad account for historical reporting.   `promotion` and `creativeFeatures` are Meta-only. Omitted settings are   preserved from the live creative, including full rebuilds. Send   `promotion: null` to remove the explicit offer from the replacement.   A supplied creativeFeatures map overrides individual existing keys. - **TikTok**: patch-style. Pass any subset; `headline` is ignored (TikTok creatives   have no headline slot). `body` becomes the in-feed `ad_text`; `linkUrl` becomes   `landing_page_url`; `videoUrl` triggers a fresh upload. `description`, `videoId`   and `existingCreativeId` are Meta-only and return 400. - **LinkedIn**: requires new media (image via `imageUrl` or video via `videoUrl`);   a text-only creative update returns 400. Uploads the media, creates a new inline   media creative on the same campaign, and pauses the old creative (best-effort).   The old creative is retained for historical reporting. `videoId` and   `existingCreativeId` are Meta-only and return 400. 
   class UpdateAdRequestCreative < ApiModelBase
+    attr_accessor :promotion
+
+    # Meta Advantage+ creative enhancements. Map snake_case feature names to OPT_IN or OPT_OUT; Meta validates supported keys and unspecified features default to OPT_OUT. auto_promotion_tag is an enhancement; use the separate promotion field for an explicit offer. The deprecated standard_enhancements bundle is rejected by Meta.
+    attr_accessor :creative_features
+
     # Meta and LinkedIn (TikTok has no headline slot)
     attr_accessor :headline
 
@@ -38,9 +43,33 @@ module Zernio
     # Meta only. Repoint the ad at an existing library creative (from GET /v1/ads/creatives); all other creative fields are ignored.
     attr_accessor :existing_creative_id
 
+    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
       {
+        :'promotion' => :'promotion',
+        :'creative_features' => :'creativeFeatures',
         :'headline' => :'headline',
         :'body' => :'body',
         :'description' => :'description',
@@ -66,6 +95,8 @@ module Zernio
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'promotion' => :'MetaPromotion',
+        :'creative_features' => :'Hash<String, String>',
         :'headline' => :'String',
         :'body' => :'String',
         :'description' => :'String',
@@ -100,6 +131,16 @@ module Zernio
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'promotion')
+        self.promotion = attributes[:'promotion']
+      end
+
+      if attributes.key?(:'creative_features')
+        if (value = attributes[:'creative_features']).is_a?(Hash)
+          self.creative_features = value
+        end
+      end
+
       if attributes.key?(:'headline')
         self.headline = attributes[:'headline']
       end
@@ -176,6 +217,8 @@ module Zernio
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          promotion == o.promotion &&
+          creative_features == o.creative_features &&
           headline == o.headline &&
           body == o.body &&
           description == o.description &&
@@ -196,7 +239,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [headline, body, description, call_to_action, link_url, image_url, video_url, video_id, existing_creative_id].hash
+      [promotion, creative_features, headline, body, description, call_to_action, link_url, image_url, video_url, video_id, existing_creative_id].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/version.rb

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

data/lib/zernio-sdk.rb

@@ -1200,6 +1200,8 @@ require 'zernio-sdk/models/media_upload_response'
 require 'zernio-sdk/models/meta_ads_platform_data'
 require 'zernio-sdk/models/meta_lead_form_platform_data'
 require 'zernio-sdk/models/meta_lead_form_platform_data_context_card'
+require 'zernio-sdk/models/meta_promotion'
+require 'zernio-sdk/models/meta_promotion_status'
 require 'zernio-sdk/models/money'
 require 'zernio-sdk/models/money_amount'
 require 'zernio-sdk/models/move_account_to_profile200_response'