late-sdk 0.0.684 → 0.0.686

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

@@ -0,0 +1,237 @@
+=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
+  # Who a comment automation answers. Instagram only - Meta exposes the follow relationship on no other platform, and only for people who have MESSAGED the account (a comment grants no consent). `whenUnknown` is therefore the important setting: it decides what happens for a first-time commenter. 
+  class CommentAutomationAudience < ApiModelBase
+    attr_accessor :follower_status
+
+    # Skip commenters with fewer followers than this. Omit for no size rule.
+    attr_accessor :min_follower_count
+
+    # What to do when Instagram will not reveal the follow relationship.   * `send` (default) - deliver the DM anyway (fails open).   * `skip` - stay silent.   * `verify` - send `followGate.message` with a confirm button. Tapping it is a     message, which grants consent, so the re-check on the tap resolves and the     real DM (or `followGate.notFollowingMessage`) follows automatically. 
+    attr_accessor :when_unknown
+
+    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
+      {
+        :'follower_status' => :'followerStatus',
+        :'min_follower_count' => :'minFollowerCount',
+        :'when_unknown' => :'whenUnknown'
+      }
+    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
+      {
+        :'follower_status' => :'String',
+        :'min_follower_count' => :'Integer',
+        :'when_unknown' => :'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::CommentAutomationAudience` 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::CommentAutomationAudience`. 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?(:'follower_status')
+        self.follower_status = attributes[:'follower_status']
+      else
+        self.follower_status = 'any'
+      end
+
+      if attributes.key?(:'min_follower_count')
+        self.min_follower_count = attributes[:'min_follower_count']
+      end
+
+      if attributes.key?(:'when_unknown')
+        self.when_unknown = attributes[:'when_unknown']
+      else
+        self.when_unknown = 'send'
+      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 !@min_follower_count.nil? && @min_follower_count < 0
+        invalid_properties.push('invalid value for "min_follower_count", 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'
+      follower_status_validator = EnumAttributeValidator.new('String', ["any", "follower", "non_follower"])
+      return false unless follower_status_validator.valid?(@follower_status)
+      return false if !@min_follower_count.nil? && @min_follower_count < 0
+      when_unknown_validator = EnumAttributeValidator.new('String', ["send", "skip", "verify"])
+      return false unless when_unknown_validator.valid?(@when_unknown)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] follower_status Object to be assigned
+    def follower_status=(follower_status)
+      validator = EnumAttributeValidator.new('String', ["any", "follower", "non_follower"])
+      unless validator.valid?(follower_status)
+        fail ArgumentError, "invalid value for \"follower_status\", must be one of #{validator.allowable_values}."
+      end
+      @follower_status = follower_status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_follower_count Value to be assigned
+    def min_follower_count=(min_follower_count)
+      if min_follower_count.nil?
+        fail ArgumentError, 'min_follower_count cannot be nil'
+      end
+
+      if min_follower_count < 0
+        fail ArgumentError, 'invalid value for "min_follower_count", must be greater than or equal to 0.'
+      end
+
+      @min_follower_count = min_follower_count
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] when_unknown Object to be assigned
+    def when_unknown=(when_unknown)
+      validator = EnumAttributeValidator.new('String', ["send", "skip", "verify"])
+      unless validator.valid?(when_unknown)
+        fail ArgumentError, "invalid value for \"when_unknown\", must be one of #{validator.allowable_values}."
+      end
+      @when_unknown = when_unknown
+    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 &&
+          follower_status == o.follower_status &&
+          min_follower_count == o.min_follower_count &&
+          when_unknown == o.when_unknown
+    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
+      [follower_status, min_follower_count, when_unknown].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/comment_automation_follow_gate.rb

@@ -0,0 +1,226 @@
+=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
+  # Copy for the follow gate. Sensible defaults are used for any field left empty.
+  class CommentAutomationFollowGate < ApiModelBase
+    # Confirmation DM sent when whenUnknown=verify.
+    attr_accessor :message
+
+    # Confirm button label. Defaults to \"I'm following\".
+    attr_accessor :button_label
+
+    # Sent to a commenter we know does not follow (followerStatus=follower). Omit to stay silent on a keyword comment; a confirm tap always gets an answer.
+    attr_accessor :not_following_message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'message' => :'message',
+        :'button_label' => :'buttonLabel',
+        :'not_following_message' => :'notFollowingMessage'
+      }
+    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
+      {
+        :'message' => :'String',
+        :'button_label' => :'String',
+        :'not_following_message' => :'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::CommentAutomationFollowGate` 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::CommentAutomationFollowGate`. 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?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'button_label')
+        self.button_label = attributes[:'button_label']
+      end
+
+      if attributes.key?(:'not_following_message')
+        self.not_following_message = attributes[:'not_following_message']
+      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 !@message.nil? && @message.to_s.length > 640
+        invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 640.')
+      end
+
+      if !@button_label.nil? && @button_label.to_s.length > 20
+        invalid_properties.push('invalid value for "button_label", the character length must be smaller than or equal to 20.')
+      end
+
+      if !@not_following_message.nil? && @not_following_message.to_s.length > 1000
+        invalid_properties.push('invalid value for "not_following_message", the character length must be smaller than or equal to 1000.')
+      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 !@message.nil? && @message.to_s.length > 640
+      return false if !@button_label.nil? && @button_label.to_s.length > 20
+      return false if !@not_following_message.nil? && @not_following_message.to_s.length > 1000
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      if message.to_s.length > 640
+        fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 640.'
+      end
+
+      @message = message
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] button_label Value to be assigned
+    def button_label=(button_label)
+      if button_label.nil?
+        fail ArgumentError, 'button_label cannot be nil'
+      end
+
+      if button_label.to_s.length > 20
+        fail ArgumentError, 'invalid value for "button_label", the character length must be smaller than or equal to 20.'
+      end
+
+      @button_label = button_label
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] not_following_message Value to be assigned
+    def not_following_message=(not_following_message)
+      if not_following_message.nil?
+        fail ArgumentError, 'not_following_message cannot be nil'
+      end
+
+      if not_following_message.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "not_following_message", the character length must be smaller than or equal to 1000.'
+      end
+
+      @not_following_message = not_following_message
+    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 &&
+          message == o.message &&
+          button_label == o.button_label &&
+          not_following_message == o.not_following_message
+    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
+      [message, button_label, not_following_message].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/conversion_event.rb

@@ -42,7 +42,7 @@ module Zernio
     # Where the conversion happened. Used by Meta. Google also requires an event source internally; omitting this field sends OTHER to Google. Send an explicit value for accurate origin reporting.
     attr_accessor :action_source
 
-    # Escape hatch for platform-specific fields we haven't normalized. Forwarded as-is.
+    # Escape hatch for platform-specific fields we haven't normalized. On Meta, keys are shallow-merged into `custom_data` only: fields Zernio already builds (`value`, `currency`, `contents`, `num_items`) always win on collision, and `user_data` (hashed match keys) is never touched. Use first-class fields (e.g. `user.leadId`) for anything that must reach `user_data`. 
     attr_accessor :platform_data
 
     class EnumAttributeValidator

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

@@ -55,6 +55,9 @@ module Zernio
     # Meta advanced matching (ge). 'f' or 'm'; hashed server-side. Meta only.
     attr_accessor :gender
 
+    # Meta lead ID from a Lead Ad submission, as a string. Required for Conversion Leads CRM events: send it with `actionSource: 'crm'` and `platformData: { event_source: 'crm', lead_event_source: '<CRM name>' }`. Forwarded unhashed to Meta's `user_data.lead_id`. Meta only. 
+    attr_accessor :lead_id
+
     attr_accessor :click_ids
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -73,6 +76,7 @@ module Zernio
         :'zip' => :'zip',
         :'dob' => :'dob',
         :'gender' => :'gender',
+        :'lead_id' => :'leadId',
         :'click_ids' => :'clickIds'
       }
     end
@@ -103,6 +107,7 @@ module Zernio
         :'zip' => :'String',
         :'dob' => :'String',
         :'gender' => :'String',
+        :'lead_id' => :'String',
         :'click_ids' => :'ConversionEventUserClickIds'
       }
     end
@@ -181,6 +186,10 @@ module Zernio
         self.gender = attributes[:'gender']
       end
 
+      if attributes.key?(:'lead_id')
+        self.lead_id = attributes[:'lead_id']
+      end
+
       if attributes.key?(:'click_ids')
         self.click_ids = attributes[:'click_ids']
       end
@@ -219,6 +228,7 @@ module Zernio
           zip == o.zip &&
           dob == o.dob &&
           gender == o.gender &&
+          lead_id == o.lead_id &&
           click_ids == o.click_ids
     end
 
@@ -231,7 +241,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, phone, first_name, last_name, external_id, ip_address, user_agent, country, city, state, zip, dob, gender, click_ids].hash
+      [email, phone, first_name, last_name, external_id, ip_address, user_agent, country, city, state, zip, dob, gender, lead_id, click_ids].hash
     end
 
     # Builds the object from hash

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

@@ -53,6 +53,16 @@ module Zernio
 
     attr_accessor :click_tag
 
+    # Seconds waited after the trigger before the DM is sent. Absent when the DM goes out immediately.
+    attr_accessor :dm_delay_seconds
+
+    # Seconds waited before the public reply is posted. Absent when it follows the DM immediately.
+    attr_accessor :comment_reply_delay_seconds
+
+    attr_accessor :audience
+
+    attr_accessor :follow_gate
+
     attr_accessor :is_active
 
     attr_accessor :stats
@@ -100,6 +110,10 @@ module Zernio
         :'comment_reply_variations' => :'commentReplyVariations',
         :'link_tracking' => :'linkTracking',
         :'click_tag' => :'clickTag',
+        :'dm_delay_seconds' => :'dmDelaySeconds',
+        :'comment_reply_delay_seconds' => :'commentReplyDelaySeconds',
+        :'audience' => :'audience',
+        :'follow_gate' => :'followGate',
         :'is_active' => :'isActive',
         :'stats' => :'stats',
         :'created_at' => :'createdAt'
@@ -135,6 +149,10 @@ module Zernio
         :'comment_reply_variations' => :'Array<String>',
         :'link_tracking' => :'Boolean',
         :'click_tag' => :'String',
+        :'dm_delay_seconds' => :'Integer',
+        :'comment_reply_delay_seconds' => :'Integer',
+        :'audience' => :'CommentAutomationAudience',
+        :'follow_gate' => :'CommentAutomationFollowGate',
         :'is_active' => :'Boolean',
         :'stats' => :'CreateCommentAutomation200ResponseAutomationStats',
         :'created_at' => :'Time'
@@ -237,6 +255,22 @@ module Zernio
         self.click_tag = attributes[:'click_tag']
       end
 
+      if attributes.key?(:'dm_delay_seconds')
+        self.dm_delay_seconds = attributes[:'dm_delay_seconds']
+      end
+
+      if attributes.key?(:'comment_reply_delay_seconds')
+        self.comment_reply_delay_seconds = attributes[:'comment_reply_delay_seconds']
+      end
+
+      if attributes.key?(:'audience')
+        self.audience = attributes[:'audience']
+      end
+
+      if attributes.key?(:'follow_gate')
+        self.follow_gate = attributes[:'follow_gate']
+      end
+
       if attributes.key?(:'is_active')
         self.is_active = attributes[:'is_active']
       end
@@ -310,6 +344,10 @@ module Zernio
           comment_reply_variations == o.comment_reply_variations &&
           link_tracking == o.link_tracking &&
           click_tag == o.click_tag &&
+          dm_delay_seconds == o.dm_delay_seconds &&
+          comment_reply_delay_seconds == o.comment_reply_delay_seconds &&
+          audience == o.audience &&
+          follow_gate == o.follow_gate &&
           is_active == o.is_active &&
           stats == o.stats &&
           created_at == o.created_at
@@ -324,7 +362,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, platform, trigger, platform_post_id, keywords, match_mode, exclude_keywords, typo_tolerance, dm_message, buttons, comment_reply, dm_message_variations, comment_reply_variations, link_tracking, click_tag, is_active, stats, created_at].hash
+      [id, name, platform, trigger, platform_post_id, keywords, match_mode, exclude_keywords, typo_tolerance, dm_message, buttons, comment_reply, dm_message_variations, comment_reply_variations, link_tracking, click_tag, dm_delay_seconds, comment_reply_delay_seconds, audience, follow_gate, is_active, stats, created_at].hash
     end
 
     # Builds the object from hash