late-sdk 0.0.855 → 0.0.857

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

@@ -226,12 +226,15 @@ module Zernio
     # Google only
     attr_accessor :campaign_type
 
-    # Google Search only. BROAD-match keywords on the new ad group. Editable later via PUT /v1/ads/{adId} targeting.keywords, which also sets match types.
+    # Google Search only. Keywords on the new ad group; entries are strings (BROAD) or { text, matchType }. Editable later via PUT /v1/ads/{adId} targeting.keywords.
     attr_accessor :keywords
 
-    # Google Search only; other platforms return 400. BROAD-match negative keywords on the new ad group. Editable later via PUT /v1/ads/{adId} targeting.negativeKeywords.
+    # Google Search only; other platforms return 400. Ad-group-level negative keywords on the new ad group. Editable later via PUT /v1/ads/{adId} targeting.negativeKeywords.
     attr_accessor :negative_keywords
 
+    # Google Search only; other platforms return 400. Campaign-level negative keywords (campaign_criterion.negative), created alongside the ad group. Editable later via PUT /v1/ads/campaigns/{campaignId}/negative-keywords.
+    attr_accessor :campaign_negative_keywords
+
     # Google Search RSA only. Extra headlines.
     attr_accessor :additional_headlines
 
@@ -390,6 +393,7 @@ module Zernio
         :'campaign_type' => :'campaignType',
         :'keywords' => :'keywords',
         :'negative_keywords' => :'negativeKeywords',
+        :'campaign_negative_keywords' => :'campaignNegativeKeywords',
         :'additional_headlines' => :'additionalHeadlines',
         :'additional_descriptions' => :'additionalDescriptions',
         :'sitelinks' => :'sitelinks',
@@ -500,8 +504,9 @@ module Zernio
         :'placement_assets' => :'CreateStandaloneAdRequestPlacementAssets',
         :'audience_id' => :'String',
         :'campaign_type' => :'String',
-        :'keywords' => :'Array<String>',
-        :'negative_keywords' => :'Array<String>',
+        :'keywords' => :'Array<KeywordEntry>',
+        :'negative_keywords' => :'Array<KeywordEntry>',
+        :'campaign_negative_keywords' => :'Array<KeywordEntry>',
         :'additional_headlines' => :'Array<String>',
         :'additional_descriptions' => :'Array<String>',
         :'sitelinks' => :'Array<CreateStandaloneAdRequestSitelinksInner>',
@@ -913,6 +918,12 @@ module Zernio
         end
       end
 
+      if attributes.key?(:'campaign_negative_keywords')
+        if (value = attributes[:'campaign_negative_keywords']).is_a?(Array)
+          self.campaign_negative_keywords = value
+        end
+      end
+
       if attributes.key?(:'additional_headlines')
         if (value = attributes[:'additional_headlines']).is_a?(Array)
           self.additional_headlines = value
@@ -1125,6 +1136,14 @@ module Zernio
         invalid_properties.push('invalid value for "keywords", number of items must be less than or equal to 1000.')
       end
 
+      if !@negative_keywords.nil? && @negative_keywords.length > 1000
+        invalid_properties.push('invalid value for "negative_keywords", number of items must be less than or equal to 1000.')
+      end
+
+      if !@campaign_negative_keywords.nil? && @campaign_negative_keywords.length > 1000
+        invalid_properties.push('invalid value for "campaign_negative_keywords", number of items must be less than or equal to 1000.')
+      end
+
       if !@sitelinks.nil? && @sitelinks.length > 20
         invalid_properties.push('invalid value for "sitelinks", number of items must be less than or equal to 20.')
       end
@@ -1225,6 +1244,8 @@ module Zernio
       campaign_type_validator = EnumAttributeValidator.new('String', ["display", "search"])
       return false unless campaign_type_validator.valid?(@campaign_type)
       return false if !@keywords.nil? && @keywords.length > 1000
+      return false if !@negative_keywords.nil? && @negative_keywords.length > 1000
+      return false if !@campaign_negative_keywords.nil? && @campaign_negative_keywords.length > 1000
       return false if !@sitelinks.nil? && @sitelinks.length > 20
       return false if !@sitelinks.nil? && @sitelinks.length < 2
       return false if !@callouts.nil? && @callouts.length > 20
@@ -1635,6 +1656,34 @@ module Zernio
       @keywords = keywords
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] negative_keywords Value to be assigned
+    def negative_keywords=(negative_keywords)
+      if negative_keywords.nil?
+        fail ArgumentError, 'negative_keywords cannot be nil'
+      end
+
+      if negative_keywords.length > 1000
+        fail ArgumentError, 'invalid value for "negative_keywords", number of items must be less than or equal to 1000.'
+      end
+
+      @negative_keywords = negative_keywords
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] campaign_negative_keywords Value to be assigned
+    def campaign_negative_keywords=(campaign_negative_keywords)
+      if campaign_negative_keywords.nil?
+        fail ArgumentError, 'campaign_negative_keywords cannot be nil'
+      end
+
+      if campaign_negative_keywords.length > 1000
+        fail ArgumentError, 'invalid value for "campaign_negative_keywords", number of items must be less than or equal to 1000.'
+      end
+
+      @campaign_negative_keywords = campaign_negative_keywords
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] sitelinks Value to be assigned
     def sitelinks=(sitelinks)
@@ -1861,6 +1910,7 @@ module Zernio
           campaign_type == o.campaign_type &&
           keywords == o.keywords &&
           negative_keywords == o.negative_keywords &&
+          campaign_negative_keywords == o.campaign_negative_keywords &&
           additional_headlines == o.additional_headlines &&
           additional_descriptions == o.additional_descriptions &&
           sitelinks == o.sitelinks &&
@@ -1892,7 +1942,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, ad_account_id, name, campaign_name, ad_set_name, ad_name, tracking, goal, optimization_goal, billing_event, buying_type, rf_prediction_id, creative_features, multi_advertiser, validate_only, budget_amount, budget_type, status, campaign_status, budget_level, currency, headline, long_headline, body, description, bodies, headlines, descriptions, call_to_action, link_url, lead_gen_form_id, image_url, images, video, creatives, ad_set_id, existing_campaign_id, existing_creative_id, business_name, board_id, organization_id, targeting, countries, cities, regions, age_min, age_max, interests, zips, metros, custom_locations, behaviors, work_positions, work_employers, work_industries, income_tier, languages, placements, saved_targeting_id, raw_targeting, special_ad_categories, special_ad_category_country, regional_regulated_categories, regional_regulation_identities, end_date, start_date, instagram_account_id, dynamic_creative, carousel_cards, default_locale, translations, placement_assets, audience_id, campaign_type, keywords, negative_keywords, additional_headlines, additional_descriptions, sitelinks, callouts, structured_snippets, advantage_audience, attribution_spec, gender, bid_strategy, bid_amount, roas_average_floor, value_rule_set_id, value_rules_applied, platform_specific_data, dsa_beneficiary, dsa_payor, brand_identity, identity_type, smart_plus, promoted_object].hash
+      [account_id, ad_account_id, name, campaign_name, ad_set_name, ad_name, tracking, goal, optimization_goal, billing_event, buying_type, rf_prediction_id, creative_features, multi_advertiser, validate_only, budget_amount, budget_type, status, campaign_status, budget_level, currency, headline, long_headline, body, description, bodies, headlines, descriptions, call_to_action, link_url, lead_gen_form_id, image_url, images, video, creatives, ad_set_id, existing_campaign_id, existing_creative_id, business_name, board_id, organization_id, targeting, countries, cities, regions, age_min, age_max, interests, zips, metros, custom_locations, behaviors, work_positions, work_employers, work_industries, income_tier, languages, placements, saved_targeting_id, raw_targeting, special_ad_categories, special_ad_category_country, regional_regulated_categories, regional_regulation_identities, end_date, start_date, instagram_account_id, dynamic_creative, carousel_cards, default_locale, translations, placement_assets, audience_id, campaign_type, keywords, negative_keywords, campaign_negative_keywords, additional_headlines, additional_descriptions, sitelinks, callouts, structured_snippets, advantage_audience, attribution_spec, gender, bid_strategy, bid_amount, roas_average_floor, value_rule_set_id, value_rules_applied, platform_specific_data, dsa_beneficiary, dsa_payor, brand_identity, identity_type, smart_plus, promoted_object].hash
     end
 
     # Builds the object from hash

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

@@ -20,11 +20,37 @@ module Zernio
 
     attr_accessor :name
 
+    # OpenAI Ads only (ignored by Meta). When set, also provisions a standard conversion event setting wired to the new pixel, so `goal: conversions` ad creates on `POST /v1/ads/create` have an event to reference immediately.
+    attr_accessor :default_event_type
+
+    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
       {
         :'ad_account_id' => :'adAccountId',
-        :'name' => :'name'
+        :'name' => :'name',
+        :'default_event_type' => :'defaultEventType'
       }
     end
 
@@ -42,7 +68,8 @@ module Zernio
     def self.openapi_types
       {
         :'ad_account_id' => :'String',
-        :'name' => :'String'
+        :'name' => :'String',
+        :'default_event_type' => :'String'
       }
     end
 
@@ -79,6 +106,10 @@ module Zernio
       else
         self.name = nil
       end
+
+      if attributes.key?(:'default_event_type')
+        self.default_event_type = attributes[:'default_event_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -113,6 +144,8 @@ module Zernio
       return false if @name.nil?
       return false if @name.to_s.length > 200
       return false if @name.to_s.length < 1
+      default_event_type_validator = EnumAttributeValidator.new('String', ["order_created", "lead_created", "items_added", "contents_viewed", "checkout_started", "registration_completed", "subscription_created", "trial_started", "appointment_scheduled", "page_viewed", "app_installed", "app_opened"])
+      return false unless default_event_type_validator.valid?(@default_event_type)
       true
     end
 
@@ -144,13 +177,24 @@ module Zernio
       @name = name
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] default_event_type Object to be assigned
+    def default_event_type=(default_event_type)
+      validator = EnumAttributeValidator.new('String', ["order_created", "lead_created", "items_added", "contents_viewed", "checkout_started", "registration_completed", "subscription_created", "trial_started", "appointment_scheduled", "page_viewed", "app_installed", "app_opened"])
+      unless validator.valid?(default_event_type)
+        fail ArgumentError, "invalid value for \"default_event_type\", must be one of #{validator.allowable_values}."
+      end
+      @default_event_type = default_event_type
+    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 &&
           ad_account_id == o.ad_account_id &&
-          name == o.name
+          name == o.name &&
+          default_event_type == o.default_event_type
     end
 
     # @see the `==` method
@@ -162,7 +206,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ad_account_id, name].hash
+      [ad_account_id, name, default_event_type].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,105 @@
+=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
+  # A Google Search keyword: a bare string (BROAD match), or an object naming the match type.
+  module KeywordEntry
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'AddAdKeywordsRequestKeywordsInnerAnyOf',
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - 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_one_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_one_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 = Zernio.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf 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

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

@@ -40,7 +40,7 @@ module Zernio
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'keywords' => :'Array<ListAdKeywords200ResponseKeywordsInner>',
+        :'keywords' => :'Array<AdKeyword>',
         :'pagination' => :'Pagination'
       }
     end

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

@@ -0,0 +1,149 @@
+=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 ListCampaignNegativeKeywords200Response < ApiModelBase
+    attr_accessor :keywords
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'keywords' => :'keywords'
+      }
+    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
+      {
+        :'keywords' => :'Array<ListCampaignNegativeKeywords200ResponseKeywordsInner>'
+      }
+    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::ListCampaignNegativeKeywords200Response` 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::ListCampaignNegativeKeywords200Response`. 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?(:'keywords')
+        if (value = attributes[:'keywords']).is_a?(Array)
+          self.keywords = value
+        end
+      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'
+      true
+    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 &&
+          keywords == o.keywords
+    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
+      [keywords].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