late-sdk 0.0.531 → 0.0.533

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

@@ -0,0 +1,323 @@
+=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 CreateRfPredictionRequest < ApiModelBase
+    # Zernio SocialAccount id (posting or ads variant).
+    attr_accessor :account_id
+
+    # Meta ad account id (act_<n>).
+    attr_accessor :ad_account_id
+
+    # Whole currency units. Exactly one of budgetAmount / reach.
+    attr_accessor :budget_amount
+
+    # Target unique reach. Exactly one of budgetAmount / reach.
+    attr_accessor :reach
+
+    # Campaign window start (must be in the future).
+    attr_accessor :start_date
+
+    attr_accessor :end_date
+
+    # Max impressions per person over the window.
+    attr_accessor :frequency_cap
+
+    # Canonical camelCase TargetingSpec (same shape as /v1/ads/create's `targeting`). Defaults to countries: [US].
+    attr_accessor :targeting
+
+    # Meta placements object (same shape as /v1/ads/create's `placements`).
+    attr_accessor :placements
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_id' => :'accountId',
+        :'ad_account_id' => :'adAccountId',
+        :'budget_amount' => :'budgetAmount',
+        :'reach' => :'reach',
+        :'start_date' => :'startDate',
+        :'end_date' => :'endDate',
+        :'frequency_cap' => :'frequencyCap',
+        :'targeting' => :'targeting',
+        :'placements' => :'placements'
+      }
+    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
+      {
+        :'account_id' => :'String',
+        :'ad_account_id' => :'String',
+        :'budget_amount' => :'Float',
+        :'reach' => :'Integer',
+        :'start_date' => :'Time',
+        :'end_date' => :'Time',
+        :'frequency_cap' => :'Integer',
+        :'targeting' => :'Object',
+        :'placements' => :'Object'
+      }
+    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::CreateRfPredictionRequest` 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::CreateRfPredictionRequest`. 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?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      else
+        self.account_id = nil
+      end
+
+      if attributes.key?(:'ad_account_id')
+        self.ad_account_id = attributes[:'ad_account_id']
+      else
+        self.ad_account_id = nil
+      end
+
+      if attributes.key?(:'budget_amount')
+        self.budget_amount = attributes[:'budget_amount']
+      end
+
+      if attributes.key?(:'reach')
+        self.reach = attributes[:'reach']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      else
+        self.start_date = nil
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      else
+        self.end_date = nil
+      end
+
+      if attributes.key?(:'frequency_cap')
+        self.frequency_cap = attributes[:'frequency_cap']
+      end
+
+      if attributes.key?(:'targeting')
+        self.targeting = attributes[:'targeting']
+      end
+
+      if attributes.key?(:'placements')
+        self.placements = attributes[:'placements']
+      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 @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @ad_account_id.nil?
+        invalid_properties.push('invalid value for "ad_account_id", ad_account_id cannot be nil.')
+      end
+
+      if @start_date.nil?
+        invalid_properties.push('invalid value for "start_date", start_date cannot be nil.')
+      end
+
+      if @end_date.nil?
+        invalid_properties.push('invalid value for "end_date", end_date cannot be nil.')
+      end
+
+      if !@frequency_cap.nil? && @frequency_cap > 90
+        invalid_properties.push('invalid value for "frequency_cap", must be smaller than or equal to 90.')
+      end
+
+      if !@frequency_cap.nil? && @frequency_cap < 1
+        invalid_properties.push('invalid value for "frequency_cap", 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 @account_id.nil?
+      return false if @ad_account_id.nil?
+      return false if @start_date.nil?
+      return false if @end_date.nil?
+      return false if !@frequency_cap.nil? && @frequency_cap > 90
+      return false if !@frequency_cap.nil? && @frequency_cap < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] account_id Value to be assigned
+    def account_id=(account_id)
+      if account_id.nil?
+        fail ArgumentError, 'account_id cannot be nil'
+      end
+
+      @account_id = account_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ad_account_id Value to be assigned
+    def ad_account_id=(ad_account_id)
+      if ad_account_id.nil?
+        fail ArgumentError, 'ad_account_id cannot be nil'
+      end
+
+      @ad_account_id = ad_account_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] start_date Value to be assigned
+    def start_date=(start_date)
+      if start_date.nil?
+        fail ArgumentError, 'start_date cannot be nil'
+      end
+
+      @start_date = start_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] end_date Value to be assigned
+    def end_date=(end_date)
+      if end_date.nil?
+        fail ArgumentError, 'end_date cannot be nil'
+      end
+
+      @end_date = end_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] frequency_cap Value to be assigned
+    def frequency_cap=(frequency_cap)
+      if frequency_cap.nil?
+        fail ArgumentError, 'frequency_cap cannot be nil'
+      end
+
+      if frequency_cap > 90
+        fail ArgumentError, 'invalid value for "frequency_cap", must be smaller than or equal to 90.'
+      end
+
+      if frequency_cap < 1
+        fail ArgumentError, 'invalid value for "frequency_cap", must be greater than or equal to 1.'
+      end
+
+      @frequency_cap = frequency_cap
+    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 &&
+          account_id == o.account_id &&
+          ad_account_id == o.ad_account_id &&
+          budget_amount == o.budget_amount &&
+          reach == o.reach &&
+          start_date == o.start_date &&
+          end_date == o.end_date &&
+          frequency_cap == o.frequency_cap &&
+          targeting == o.targeting &&
+          placements == o.placements
+    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
+      [account_id, ad_account_id, budget_amount, reach, start_date, end_date, frequency_cap, targeting, placements].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/create_standalone_ad_request.rb

@@ -41,6 +41,12 @@ module Zernio
     # Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal.
     attr_accessor :billing_event
 
+    # Meta only. RESERVED = Reach & Frequency: requires `rfPredictionId` (a RESERVED prediction from /v1/ads/rf-predictions + /reserve). Budget, schedule and pricing come from the reservation, so budgetAmount/budgetType are not required and bid fields are ignored. Only the plain single-ad shape (no creatives[], adSetId, existingCampaignId or dynamicCreative).
+    attr_accessor :buying_type
+
+    # Meta only. The RESERVED prediction id the R&F ad set runs on (reserving mints a new id — pass that one). Requires buyingType RESERVED.
+    attr_accessor :rf_prediction_id
+
     # Required on legacy + multi-creative shapes. Inherited on attach.
     attr_accessor :budget_amount
 
@@ -251,6 +257,8 @@ module Zernio
         :'goal' => :'goal',
         :'optimization_goal' => :'optimizationGoal',
         :'billing_event' => :'billingEvent',
+        :'buying_type' => :'buyingType',
+        :'rf_prediction_id' => :'rfPredictionId',
         :'budget_amount' => :'budgetAmount',
         :'budget_type' => :'budgetType',
         :'status' => :'status',
@@ -339,6 +347,8 @@ module Zernio
         :'goal' => :'String',
         :'optimization_goal' => :'String',
         :'billing_event' => :'String',
+        :'buying_type' => :'String',
+        :'rf_prediction_id' => :'String',
         :'budget_amount' => :'Float',
         :'budget_type' => :'String',
         :'status' => :'String',
@@ -472,6 +482,14 @@ module Zernio
         self.billing_event = attributes[:'billing_event']
       end
 
+      if attributes.key?(:'buying_type')
+        self.buying_type = attributes[:'buying_type']
+      end
+
+      if attributes.key?(:'rf_prediction_id')
+        self.rf_prediction_id = attributes[:'rf_prediction_id']
+      end
+
       if attributes.key?(:'budget_amount')
         self.budget_amount = attributes[:'budget_amount']
       end
@@ -866,6 +884,8 @@ module Zernio
       return false if !@ad_name.nil? && @ad_name.to_s.length > 255
       goal_validator = EnumAttributeValidator.new('String', ["engagement", "traffic", "awareness", "video_views", "lead_generation", "lead_conversion", "conversions", "app_promotion", "catalog_sales", "job_applicants"])
       return false unless goal_validator.valid?(@goal)
+      buying_type_validator = EnumAttributeValidator.new('String', ["AUCTION", "RESERVED"])
+      return false unless buying_type_validator.valid?(@buying_type)
       budget_type_validator = EnumAttributeValidator.new('String', ["daily", "lifetime"])
       return false unless budget_type_validator.valid?(@budget_type)
       status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "PAUSED"])
@@ -987,6 +1007,16 @@ module Zernio
       @goal = goal
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] buying_type Object to be assigned
+    def buying_type=(buying_type)
+      validator = EnumAttributeValidator.new('String', ["AUCTION", "RESERVED"])
+      unless validator.valid?(buying_type)
+        fail ArgumentError, "invalid value for \"buying_type\", must be one of #{validator.allowable_values}."
+      end
+      @buying_type = buying_type
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] budget_type Object to be assigned
     def budget_type=(budget_type)
@@ -1248,6 +1278,8 @@ module Zernio
           goal == o.goal &&
           optimization_goal == o.optimization_goal &&
           billing_event == o.billing_event &&
+          buying_type == o.buying_type &&
+          rf_prediction_id == o.rf_prediction_id &&
           budget_amount == o.budget_amount &&
           budget_type == o.budget_type &&
           status == o.status &&
@@ -1321,7 +1353,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, budget_amount, budget_type, status, budget_level, currency, headline, long_headline, body, description, 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, income_tier, languages, placements, saved_targeting_id, raw_targeting, special_ad_categories, end_date, start_date, instagram_account_id, dynamic_creative, carousel_cards, placement_assets, audience_id, campaign_type, keywords, additional_headlines, additional_descriptions, advantage_audience, attribution_spec, gender, bid_strategy, bid_amount, roas_average_floor, platform_specific_data, dsa_beneficiary, dsa_payor, brand_identity, identity_type, 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, budget_amount, budget_type, status, budget_level, currency, headline, long_headline, body, description, 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, income_tier, languages, placements, saved_targeting_id, raw_targeting, special_ad_categories, end_date, start_date, instagram_account_id, dynamic_creative, carousel_cards, placement_assets, audience_id, campaign_type, keywords, additional_headlines, additional_descriptions, advantage_audience, attribution_spec, gender, bid_strategy, bid_amount, roas_average_floor, platform_specific_data, dsa_beneficiary, dsa_payor, brand_identity, identity_type, promoted_object].hash
     end
 
     # Builds the object from hash

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

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