late-sdk 0.0.950 → 0.0.952

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

@@ -0,0 +1,329 @@
+=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
+  # One ad schedule window as Google stores it. Half-open: it is exclusive of the end minute, so 09:00-12:00 and 12:00-17:00 are adjacent, not overlapping.
+  class AdScheduleWindow < ApiModelBase
+    # Google campaign criterion id. Changes whenever the window is rewritten, because Google cannot edit a schedule in place.
+    attr_accessor :criterion_id
+
+    attr_accessor :resource_name
+
+    attr_accessor :day_of_week
+
+    attr_accessor :start_hour
+
+    attr_accessor :start_minute
+
+    # 24 means midnight at the end of the day.
+    attr_accessor :end_hour
+
+    attr_accessor :end_minute
+
+    # Bid adjustment for this window, 0.1-10.0. Null when the window runs at the campaign bid.
+    attr_accessor :bid_modifier
+
+    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
+      {
+        :'criterion_id' => :'criterionId',
+        :'resource_name' => :'resourceName',
+        :'day_of_week' => :'dayOfWeek',
+        :'start_hour' => :'startHour',
+        :'start_minute' => :'startMinute',
+        :'end_hour' => :'endHour',
+        :'end_minute' => :'endMinute',
+        :'bid_modifier' => :'bidModifier'
+      }
+    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
+      {
+        :'criterion_id' => :'String',
+        :'resource_name' => :'String',
+        :'day_of_week' => :'String',
+        :'start_hour' => :'Integer',
+        :'start_minute' => :'Integer',
+        :'end_hour' => :'Integer',
+        :'end_minute' => :'Integer',
+        :'bid_modifier' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'bid_modifier'
+      ])
+    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::AdScheduleWindow` 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::AdScheduleWindow`. 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?(:'criterion_id')
+        self.criterion_id = attributes[:'criterion_id']
+      end
+
+      if attributes.key?(:'resource_name')
+        self.resource_name = attributes[:'resource_name']
+      end
+
+      if attributes.key?(:'day_of_week')
+        self.day_of_week = attributes[:'day_of_week']
+      end
+
+      if attributes.key?(:'start_hour')
+        self.start_hour = attributes[:'start_hour']
+      end
+
+      if attributes.key?(:'start_minute')
+        self.start_minute = attributes[:'start_minute']
+      end
+
+      if attributes.key?(:'end_hour')
+        self.end_hour = attributes[:'end_hour']
+      end
+
+      if attributes.key?(:'end_minute')
+        self.end_minute = attributes[:'end_minute']
+      end
+
+      if attributes.key?(:'bid_modifier')
+        self.bid_modifier = attributes[:'bid_modifier']
+      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 !@start_hour.nil? && @start_hour > 23
+        invalid_properties.push('invalid value for "start_hour", must be smaller than or equal to 23.')
+      end
+
+      if !@start_hour.nil? && @start_hour < 0
+        invalid_properties.push('invalid value for "start_hour", must be greater than or equal to 0.')
+      end
+
+      if !@end_hour.nil? && @end_hour > 24
+        invalid_properties.push('invalid value for "end_hour", must be smaller than or equal to 24.')
+      end
+
+      if !@end_hour.nil? && @end_hour < 0
+        invalid_properties.push('invalid value for "end_hour", must be greater than or equal to 0.')
+      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'
+      day_of_week_validator = EnumAttributeValidator.new('String', ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"])
+      return false unless day_of_week_validator.valid?(@day_of_week)
+      return false if !@start_hour.nil? && @start_hour > 23
+      return false if !@start_hour.nil? && @start_hour < 0
+      start_minute_validator = EnumAttributeValidator.new('Integer', [0, 15, 30, 45])
+      return false unless start_minute_validator.valid?(@start_minute)
+      return false if !@end_hour.nil? && @end_hour > 24
+      return false if !@end_hour.nil? && @end_hour < 0
+      end_minute_validator = EnumAttributeValidator.new('Integer', [0, 15, 30, 45])
+      return false unless end_minute_validator.valid?(@end_minute)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] day_of_week Object to be assigned
+    def day_of_week=(day_of_week)
+      validator = EnumAttributeValidator.new('String', ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"])
+      unless validator.valid?(day_of_week)
+        fail ArgumentError, "invalid value for \"day_of_week\", must be one of #{validator.allowable_values}."
+      end
+      @day_of_week = day_of_week
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] start_hour Value to be assigned
+    def start_hour=(start_hour)
+      if start_hour.nil?
+        fail ArgumentError, 'start_hour cannot be nil'
+      end
+
+      if start_hour > 23
+        fail ArgumentError, 'invalid value for "start_hour", must be smaller than or equal to 23.'
+      end
+
+      if start_hour < 0
+        fail ArgumentError, 'invalid value for "start_hour", must be greater than or equal to 0.'
+      end
+
+      @start_hour = start_hour
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] start_minute Object to be assigned
+    def start_minute=(start_minute)
+      validator = EnumAttributeValidator.new('Integer', [0, 15, 30, 45])
+      unless validator.valid?(start_minute)
+        fail ArgumentError, "invalid value for \"start_minute\", must be one of #{validator.allowable_values}."
+      end
+      @start_minute = start_minute
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] end_hour Value to be assigned
+    def end_hour=(end_hour)
+      if end_hour.nil?
+        fail ArgumentError, 'end_hour cannot be nil'
+      end
+
+      if end_hour > 24
+        fail ArgumentError, 'invalid value for "end_hour", must be smaller than or equal to 24.'
+      end
+
+      if end_hour < 0
+        fail ArgumentError, 'invalid value for "end_hour", must be greater than or equal to 0.'
+      end
+
+      @end_hour = end_hour
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] end_minute Object to be assigned
+    def end_minute=(end_minute)
+      validator = EnumAttributeValidator.new('Integer', [0, 15, 30, 45])
+      unless validator.valid?(end_minute)
+        fail ArgumentError, "invalid value for \"end_minute\", must be one of #{validator.allowable_values}."
+      end
+      @end_minute = end_minute
+    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 &&
+          criterion_id == o.criterion_id &&
+          resource_name == o.resource_name &&
+          day_of_week == o.day_of_week &&
+          start_hour == o.start_hour &&
+          start_minute == o.start_minute &&
+          end_hour == o.end_hour &&
+          end_minute == o.end_minute &&
+          bid_modifier == o.bid_modifier
+    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
+      [criterion_id, resource_name, day_of_week, start_hour, start_minute, end_hour, end_minute, bid_modifier].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/boost_post_request.rb

@@ -93,6 +93,8 @@ module Zernio
     # TikTok-only. Spark Code (creator's `auth_code`) authorizing cross-creator Spark Ads: the advertiser can boost a video owned by a DIFFERENT TikTok account. Without this, boosts are limited to videos owned by the same account running the ads (same-BC creators only). The creator generates the code in their TikTok app's Promote settings and shares it with the advertiser. Maps to `auth_code` on the creative entry of /v2/ad/create/. 
     attr_accessor :spark_auth_code
 
+    attr_accessor :promoted_object
+
     # Legal entity that benefits from the ad. Required when targeting EU users (EU DSA, Article 26). Optional if the ad account has a default beneficiary: set it once via `PATCH /v1/ads/accounts` or in Meta Ads Manager, and Meta fills it in whenever the field is omitted. 
     attr_accessor :dsa_beneficiary
 
@@ -161,6 +163,7 @@ module Zernio
         :'link_url' => :'linkUrl',
         :'call_to_action' => :'callToAction',
         :'spark_auth_code' => :'sparkAuthCode',
+        :'promoted_object' => :'promotedObject',
         :'dsa_beneficiary' => :'dsaBeneficiary',
         :'dsa_payor' => :'dsaPayor',
         :'lead_gen_form_id' => :'leadGenFormId',
@@ -210,6 +213,7 @@ module Zernio
         :'link_url' => :'String',
         :'call_to_action' => :'String',
         :'spark_auth_code' => :'String',
+        :'promoted_object' => :'BoostPostRequestPromotedObject',
         :'dsa_beneficiary' => :'String',
         :'dsa_payor' => :'String',
         :'lead_gen_form_id' => :'String',
@@ -372,6 +376,10 @@ module Zernio
         self.spark_auth_code = attributes[:'spark_auth_code']
       end
 
+      if attributes.key?(:'promoted_object')
+        self.promoted_object = attributes[:'promoted_object']
+      end
+
       if attributes.key?(:'dsa_beneficiary')
         self.dsa_beneficiary = attributes[:'dsa_beneficiary']
       end
@@ -623,6 +631,7 @@ module Zernio
           link_url == o.link_url &&
           call_to_action == o.call_to_action &&
           spark_auth_code == o.spark_auth_code &&
+          promoted_object == o.promoted_object &&
           dsa_beneficiary == o.dsa_beneficiary &&
           dsa_payor == o.dsa_payor &&
           lead_gen_form_id == o.lead_gen_form_id &&
@@ -639,7 +648,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [creative_features, post_id, platform_post_id, account_id, ad_account_id, name, goal, ad_set_id, budget, instagram_account_id, destination_type, whatsapp_phone_number, currency, schedule, targeting, raw_targeting, bid_strategy, bid_amount, roas_average_floor, platform_specific_data, tracking, special_ad_categories, special_ad_category_country, regional_regulated_categories, regional_regulation_identities, link_url, call_to_action, spark_auth_code, dsa_beneficiary, dsa_payor, lead_gen_form_id, status, optimization_goal].hash
+      [creative_features, post_id, platform_post_id, account_id, ad_account_id, name, goal, ad_set_id, budget, instagram_account_id, destination_type, whatsapp_phone_number, currency, schedule, targeting, raw_targeting, bid_strategy, bid_amount, roas_average_floor, platform_specific_data, tracking, special_ad_categories, special_ad_category_country, regional_regulated_categories, regional_regulation_identities, link_url, call_to_action, spark_auth_code, promoted_object, dsa_beneficiary, dsa_payor, lead_gen_form_id, status, optimization_goal].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,159 @@
+=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
+  # TikTok-only on this endpoint. The pixel a Website Conversion ad group optimizes toward, so a Spark Ad built from an existing organic post can optimize for a conversion instead of only engagement or traffic. Required when `goal` is `conversions`; ignored on every other goal, because only a WEB_CONVERSIONS ad group accepts these fields.  Combine freely with `platformPostId` + `sparkAuthCode`: the pixel lives on the ad group and the Spark item on the creative, so they never conflict. 
+  class BoostPostRequestPromotedObject < ApiModelBase
+    # TikTok Pixel. Either the numeric pixel id or the alphanumeric pixel code from Events Manager, which is resolved for you.
+    attr_accessor :pixel_id
+
+    # Optimization event, as a TikTok optimization_event code (e.g. ON_WEB_ORDER, SHOPPING, FORM) or the exact event name shown in Events Manager, which is resolved to its code. Omit to let TikTok optimize for the ad group default.
+    attr_accessor :custom_event_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pixel_id' => :'pixelId',
+        :'custom_event_type' => :'customEventType'
+      }
+    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
+      {
+        :'pixel_id' => :'String',
+        :'custom_event_type' => :'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::BoostPostRequestPromotedObject` 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::BoostPostRequestPromotedObject`. 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?(:'pixel_id')
+        self.pixel_id = attributes[:'pixel_id']
+      end
+
+      if attributes.key?(:'custom_event_type')
+        self.custom_event_type = attributes[:'custom_event_type']
+      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 &&
+          pixel_id == o.pixel_id &&
+          custom_event_type == o.custom_event_type
+    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
+      [pixel_id, custom_event_type].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