pinterest_sdk 1.0.0

data/lib/pinterest_sdk/models/ad_group_response.rb

@@ -0,0 +1,555 @@
+=begin
+#Pinterest REST API
+
+#Pinterest's REST API
+
+The version of the OpenAPI document: 5.3.0
+Contact: pinterest-api@pinterest.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PinterestSdkClient
+  class AdGroupResponse
+    # Ad group name.
+    attr_accessor :name
+
+    # Ad group/entity status.
+    attr_accessor :status
+
+    # Budget in micro currency. This field is **REQUIRED** for non-CBO (campaign budget optimization) campaigns.  A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome. A CBO campaign is limited to 70 or less ad groups.
+    attr_accessor :budget_in_micro_currency
+
+    # Bid price in micro currency. This field is **REQUIRED** for the following campaign objective_type/billable_event combinations: AWARENESS/IMPRESSION, CONSIDERATION/CLICKTHROUGH, CATALOG_SALES/CLICKTHROUGH, VIDEO_VIEW/VIDEO_V_50_MRC.
+    attr_accessor :bid_in_micro_currency
+
+    # Budget type. If DAILY, an ad group's daily spend will not exceed the budget parameter value. If LIFETIME, the end_time parameter is **REQUIRED**, and the ad group spend is spread evenly between the ad group `start_time` and `end_time` range. A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome.
+    attr_accessor :budget_type
+
+    # Ad group start time. Unix timestamp in seconds. Defaults to current time.
+    attr_accessor :start_time
+
+    # Ad group end time. Unix timestamp in seconds.
+    attr_accessor :end_time
+
+    # Ad group targeting specification defining the ad group target audience. For example, '{\"APPTYPE\":[\"iphone\"], \"GENDER\":[\"male\"], \"LOCALE\":[\"en-US\"], \"LOCATION\":[\"501\"], \"AGE_BUCKET\":[\"25-34\"]}'
+    attr_accessor :targeting_spec
+
+    # Set a limit to the number of times a promoted pin from this campaign can be impressed by a pinner within the past rolling 30 days. Only available for CPM (cost per mille (1000 impressions))  ad groups. A CPM ad group has an IMPRESSION <a href=\\\"/docs/redoc/#section/Billable-event\\\">billable_event</a> value. This field **REQUIRES** the `end_time` field.
+    attr_accessor :lifetime_frequency_cap
+
+    # Third-party tracking URLs.<br> JSON object with the format: {\"<a href=\"https://developers.pinterest.com/docs/redoc/#section/Tracking-URL-event\">Tracking event enum</a>\":[URL string array],...}<br> For example: {\"impression\": [\"URL1\", \"URL2\"], \"click\": [\"URL1\", \"URL2\", \"URL3\"]}.<br>Up to three tracking URLs are supported for each event type. Tracking URLs set at the ad group or ad level can override those set at the campaign level. May be null. Pass in an empty object - {} - to remove tracking URLs.<br><br> For more information, see <a href=\"https://help.pinterest.com/en/business/article/third-party-and-dynamic-tracking\" target=\"_blank\">Third-party and dynamic tracking</a>.
+    attr_accessor :tracking_urls
+
+    # Enable auto-targeting for ad group. Also known as <a href=\"https://help.pinterest.com/en/business/article/expanded-targeting\" target=\"_blank\">\"expanded targeting\"</a>.
+    attr_accessor :auto_targeting_enabled
+
+    # <a href=\\\"/docs/redoc/#section/Placement-group\\\">Placement group</a>.
+    attr_accessor :placement_group
+
+    # Pacing delivery type. With ACCELERATED, an ad group budget is spent as fast as possible. With STANDARD, an ad group budget is spent smoothly over a day.
+    attr_accessor :pacing_delivery_type
+
+    # oCPM learn mode
+    attr_accessor :conversion_learning_mode_type
+
+    # Ad group summary status.
+    attr_accessor :summary_status
+
+    # Feed Profile ID associated to the adgroup.
+    attr_accessor :feed_profile_id
+
+    # Campaign ID of the ad group.
+    attr_accessor :campaign_id
+
+    attr_accessor :billable_event
+
+    # Ad group ID.
+    attr_accessor :id
+
+    # Always \"adgroup\".
+    attr_accessor :type
+
+    # Advertiser ID.
+    attr_accessor :ad_account_id
+
+    # Ad group creation time. Unix timestamp in seconds.
+    attr_accessor :created_time
+
+    # Ad group last update time. Unix timestamp in seconds.
+    attr_accessor :updated_time
+
+    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
+      {
+        :'name' => :'name',
+        :'status' => :'status',
+        :'budget_in_micro_currency' => :'budget_in_micro_currency',
+        :'bid_in_micro_currency' => :'bid_in_micro_currency',
+        :'budget_type' => :'budget_type',
+        :'start_time' => :'start_time',
+        :'end_time' => :'end_time',
+        :'targeting_spec' => :'targeting_spec',
+        :'lifetime_frequency_cap' => :'lifetime_frequency_cap',
+        :'tracking_urls' => :'tracking_urls',
+        :'auto_targeting_enabled' => :'auto_targeting_enabled',
+        :'placement_group' => :'placement_group',
+        :'pacing_delivery_type' => :'pacing_delivery_type',
+        :'conversion_learning_mode_type' => :'conversion_learning_mode_type',
+        :'summary_status' => :'summary_status',
+        :'feed_profile_id' => :'feed_profile_id',
+        :'campaign_id' => :'campaign_id',
+        :'billable_event' => :'billable_event',
+        :'id' => :'id',
+        :'type' => :'type',
+        :'ad_account_id' => :'ad_account_id',
+        :'created_time' => :'created_time',
+        :'updated_time' => :'updated_time'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'status' => :'EntityStatus',
+        :'budget_in_micro_currency' => :'Integer',
+        :'bid_in_micro_currency' => :'Integer',
+        :'budget_type' => :'String',
+        :'start_time' => :'Integer',
+        :'end_time' => :'Integer',
+        :'targeting_spec' => :'Hash<String, Array<String>>',
+        :'lifetime_frequency_cap' => :'Integer',
+        :'tracking_urls' => :'TrackingUrls',
+        :'auto_targeting_enabled' => :'Boolean',
+        :'placement_group' => :'PlacementGroupType',
+        :'pacing_delivery_type' => :'PacingDeliveryType',
+        :'conversion_learning_mode_type' => :'String',
+        :'summary_status' => :'AdGroupSummaryStatus',
+        :'feed_profile_id' => :'String',
+        :'campaign_id' => :'String',
+        :'billable_event' => :'ActionType',
+        :'id' => :'String',
+        :'type' => :'String',
+        :'ad_account_id' => :'String',
+        :'created_time' => :'Integer',
+        :'updated_time' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'budget_in_micro_currency',
+        :'bid_in_micro_currency',
+        :'start_time',
+        :'end_time',
+        :'tracking_urls',
+        :'auto_targeting_enabled',
+        :'conversion_learning_mode_type',
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'AdGroupResponseAllOf',
+      :'AdGroupResponseAllOf1'
+      ]
+    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 `PinterestSdkClient::AdGroupResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PinterestSdkClient::AdGroupResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'budget_in_micro_currency')
+        self.budget_in_micro_currency = attributes[:'budget_in_micro_currency']
+      end
+
+      if attributes.key?(:'bid_in_micro_currency')
+        self.bid_in_micro_currency = attributes[:'bid_in_micro_currency']
+      end
+
+      if attributes.key?(:'budget_type')
+        self.budget_type = attributes[:'budget_type']
+      end
+
+      if attributes.key?(:'start_time')
+        self.start_time = attributes[:'start_time']
+      end
+
+      if attributes.key?(:'end_time')
+        self.end_time = attributes[:'end_time']
+      end
+
+      if attributes.key?(:'targeting_spec')
+        if (value = attributes[:'targeting_spec']).is_a?(Hash)
+          self.targeting_spec = value
+        end
+      end
+
+      if attributes.key?(:'lifetime_frequency_cap')
+        self.lifetime_frequency_cap = attributes[:'lifetime_frequency_cap']
+      end
+
+      if attributes.key?(:'tracking_urls')
+        if (value = attributes[:'tracking_urls']).is_a?(Hash)
+          self.tracking_urls = value
+        end
+        self.tracking_urls = attributes[:'tracking_urls']
+      end
+
+      if attributes.key?(:'auto_targeting_enabled')
+        self.auto_targeting_enabled = attributes[:'auto_targeting_enabled']
+      end
+
+      if attributes.key?(:'placement_group')
+        self.placement_group = attributes[:'placement_group']
+      end
+
+      if attributes.key?(:'pacing_delivery_type')
+        self.pacing_delivery_type = attributes[:'pacing_delivery_type']
+      end
+
+      if attributes.key?(:'conversion_learning_mode_type')
+        self.conversion_learning_mode_type = attributes[:'conversion_learning_mode_type']
+      end
+
+      if attributes.key?(:'summary_status')
+        self.summary_status = attributes[:'summary_status']
+      end
+
+      if attributes.key?(:'feed_profile_id')
+        self.feed_profile_id = attributes[:'feed_profile_id']
+      end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'billable_event')
+        self.billable_event = attributes[:'billable_event']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'ad_account_id')
+        self.ad_account_id = attributes[:'ad_account_id']
+      end
+
+      if attributes.key?(:'created_time')
+        self.created_time = attributes[:'created_time']
+      end
+
+      if attributes.key?(:'updated_time')
+        self.updated_time = attributes[:'updated_time']
+      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
+      invalid_properties = Array.new
+      pattern = Regexp.new(/^\d+$/)
+      if !@campaign_id.nil? && @campaign_id !~ pattern
+        invalid_properties.push("invalid value for \"campaign_id\", must conform to the pattern #{pattern}.")
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if !@id.nil? && @id !~ pattern
+        invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if !@ad_account_id.nil? && @ad_account_id !~ pattern
+        invalid_properties.push("invalid value for \"ad_account_id\", must conform to the pattern #{pattern}.")
+      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?
+      budget_type_validator = EnumAttributeValidator.new('String', ["DAILY", "LIFETIME", "CBO_ADGROUP"])
+      return false unless budget_type_validator.valid?(@budget_type)
+      conversion_learning_mode_type_validator = EnumAttributeValidator.new('String', ["NOT_ACTIVE", "ACTIVE", "null"])
+      return false unless conversion_learning_mode_type_validator.valid?(@conversion_learning_mode_type)
+      return false if !@campaign_id.nil? && @campaign_id !~ Regexp.new(/^\d+$/)
+      return false if !@id.nil? && @id !~ Regexp.new(/^\d+$/)
+      return false if !@ad_account_id.nil? && @ad_account_id !~ Regexp.new(/^\d+$/)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] budget_type Object to be assigned
+    def budget_type=(budget_type)
+      validator = EnumAttributeValidator.new('String', ["DAILY", "LIFETIME", "CBO_ADGROUP"])
+      unless validator.valid?(budget_type)
+        fail ArgumentError, "invalid value for \"budget_type\", must be one of #{validator.allowable_values}."
+      end
+      @budget_type = budget_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] conversion_learning_mode_type Object to be assigned
+    def conversion_learning_mode_type=(conversion_learning_mode_type)
+      validator = EnumAttributeValidator.new('String', ["NOT_ACTIVE", "ACTIVE", "null"])
+      unless validator.valid?(conversion_learning_mode_type)
+        fail ArgumentError, "invalid value for \"conversion_learning_mode_type\", must be one of #{validator.allowable_values}."
+      end
+      @conversion_learning_mode_type = conversion_learning_mode_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] campaign_id Value to be assigned
+    def campaign_id=(campaign_id)
+      pattern = Regexp.new(/^\d+$/)
+      if !campaign_id.nil? && campaign_id !~ pattern
+        fail ArgumentError, "invalid value for \"campaign_id\", must conform to the pattern #{pattern}."
+      end
+
+      @campaign_id = campaign_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      pattern = Regexp.new(/^\d+$/)
+      if !id.nil? && id !~ pattern
+        fail ArgumentError, "invalid value for \"id\", must conform to the pattern #{pattern}."
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ad_account_id Value to be assigned
+    def ad_account_id=(ad_account_id)
+      pattern = Regexp.new(/^\d+$/)
+      if !ad_account_id.nil? && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for \"ad_account_id\", must conform to the pattern #{pattern}."
+      end
+
+      @ad_account_id = ad_account_id
+    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 &&
+          name == o.name &&
+          status == o.status &&
+          budget_in_micro_currency == o.budget_in_micro_currency &&
+          bid_in_micro_currency == o.bid_in_micro_currency &&
+          budget_type == o.budget_type &&
+          start_time == o.start_time &&
+          end_time == o.end_time &&
+          targeting_spec == o.targeting_spec &&
+          lifetime_frequency_cap == o.lifetime_frequency_cap &&
+          tracking_urls == o.tracking_urls &&
+          auto_targeting_enabled == o.auto_targeting_enabled &&
+          placement_group == o.placement_group &&
+          pacing_delivery_type == o.pacing_delivery_type &&
+          conversion_learning_mode_type == o.conversion_learning_mode_type &&
+          summary_status == o.summary_status &&
+          feed_profile_id == o.feed_profile_id &&
+          campaign_id == o.campaign_id &&
+          billable_event == o.billable_event &&
+          id == o.id &&
+          type == o.type &&
+          ad_account_id == o.ad_account_id &&
+          created_time == o.created_time &&
+          updated_time == o.updated_time
+    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
+      [name, status, budget_in_micro_currency, bid_in_micro_currency, budget_type, start_time, end_time, targeting_spec, lifetime_frequency_cap, tracking_urls, auto_targeting_enabled, placement_group, pacing_delivery_type, conversion_learning_mode_type, summary_status, feed_profile_id, campaign_id, billable_event, id, type, ad_account_id, created_time, updated_time].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = PinterestSdkClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end