klaviyo-api-sdk 18.0.0 → 19.0.0

data/lib/klaviyo-api-sdk/models/push_channel_details.rb

@@ -0,0 +1,512 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class PushChannelDetails
+    attr_accessor :channel
+
+    attr_accessor :title
+
+    attr_accessor :body
+
+    attr_accessor :badge
+
+    # A push message variation's badge config.
+    attr_accessor :badge_config
+
+    attr_accessor :badge_value
+
+    attr_accessor :sound_file_name
+
+    attr_accessor :static_asset_id
+
+    attr_accessor :sound
+
+    attr_accessor :open_action
+
+    attr_accessor :dynamic_media_template
+
+    attr_accessor :kv_pairs
+
+    # A push message variation's push type.
+    attr_accessor :push_type
+
+    attr_accessor :ios_deep_link
+
+    attr_accessor :android_deep_link
+
+    attr_accessor :web_url
+
+    attr_accessor :content_available
+
+    attr_accessor :send_to_inbox
+
+    attr_accessor :mutable_content
+
+    attr_accessor :video_asset_id
+
+    attr_accessor :action_buttons
+
+    attr_accessor :push_platform_target
+
+    attr_accessor :send_to_primary
+
+    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
+      {
+        :'channel' => :'channel',
+        :'title' => :'title',
+        :'body' => :'body',
+        :'badge' => :'badge',
+        :'badge_config' => :'badge_config',
+        :'badge_value' => :'badge_value',
+        :'sound_file_name' => :'sound_file_name',
+        :'static_asset_id' => :'static_asset_id',
+        :'sound' => :'sound',
+        :'open_action' => :'open_action',
+        :'dynamic_media_template' => :'dynamic_media_template',
+        :'kv_pairs' => :'kv_pairs',
+        :'push_type' => :'push_type',
+        :'ios_deep_link' => :'ios_deep_link',
+        :'android_deep_link' => :'android_deep_link',
+        :'web_url' => :'web_url',
+        :'content_available' => :'content_available',
+        :'send_to_inbox' => :'send_to_inbox',
+        :'mutable_content' => :'mutable_content',
+        :'video_asset_id' => :'video_asset_id',
+        :'action_buttons' => :'action_buttons',
+        :'push_platform_target' => :'push_platform_target',
+        :'send_to_primary' => :'send_to_primary'
+      }
+    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
+      {
+        :'channel' => :'String',
+        :'title' => :'String',
+        :'body' => :'String',
+        :'badge' => :'Boolean',
+        :'badge_config' => :'String',
+        :'badge_value' => :'String',
+        :'sound_file_name' => :'String',
+        :'static_asset_id' => :'Integer',
+        :'sound' => :'Boolean',
+        :'open_action' => :'Integer',
+        :'dynamic_media_template' => :'String',
+        :'kv_pairs' => :'Object',
+        :'push_type' => :'String',
+        :'ios_deep_link' => :'String',
+        :'android_deep_link' => :'String',
+        :'web_url' => :'String',
+        :'content_available' => :'Boolean',
+        :'send_to_inbox' => :'Boolean',
+        :'mutable_content' => :'Boolean',
+        :'video_asset_id' => :'String',
+        :'action_buttons' => :'Array<PushActionButtonV0>',
+        :'push_platform_target' => :'Integer',
+        :'send_to_primary' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'static_asset_id',
+        :'kv_pairs',
+        :'ios_deep_link',
+        :'android_deep_link',
+        :'web_url',
+        :'content_available',
+        :'send_to_inbox',
+        :'mutable_content',
+        :'video_asset_id',
+        :'action_buttons',
+        :'push_platform_target',
+        :'send_to_primary'
+      ])
+    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 `KlaviyoAPI::PushChannelDetails` 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 `KlaviyoAPI::PushChannelDetails`. 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?(:'channel')
+        self.channel = attributes[:'channel']
+      else
+        self.channel = 'push'
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = ''
+      end
+
+      if attributes.key?(:'body')
+        self.body = attributes[:'body']
+      else
+        self.body = ''
+      end
+
+      if attributes.key?(:'badge')
+        self.badge = attributes[:'badge']
+      else
+        self.badge = false
+      end
+
+      if attributes.key?(:'badge_config')
+        self.badge_config = attributes[:'badge_config']
+      else
+        self.badge_config = 'increment-one'
+      end
+
+      if attributes.key?(:'badge_value')
+        self.badge_value = attributes[:'badge_value']
+      else
+        self.badge_value = '1'
+      end
+
+      if attributes.key?(:'sound_file_name')
+        self.sound_file_name = attributes[:'sound_file_name']
+      else
+        self.sound_file_name = ''
+      end
+
+      if attributes.key?(:'static_asset_id')
+        self.static_asset_id = attributes[:'static_asset_id']
+      end
+
+      if attributes.key?(:'sound')
+        self.sound = attributes[:'sound']
+      else
+        self.sound = false
+      end
+
+      if attributes.key?(:'open_action')
+        self.open_action = attributes[:'open_action']
+      else
+        self.open_action = 0
+      end
+
+      if attributes.key?(:'dynamic_media_template')
+        self.dynamic_media_template = attributes[:'dynamic_media_template']
+      else
+        self.dynamic_media_template = ''
+      end
+
+      if attributes.key?(:'kv_pairs')
+        self.kv_pairs = attributes[:'kv_pairs']
+      end
+
+      if attributes.key?(:'push_type')
+        self.push_type = attributes[:'push_type']
+      else
+        self.push_type = 'standard'
+      end
+
+      if attributes.key?(:'ios_deep_link')
+        self.ios_deep_link = attributes[:'ios_deep_link']
+      end
+
+      if attributes.key?(:'android_deep_link')
+        self.android_deep_link = attributes[:'android_deep_link']
+      end
+
+      if attributes.key?(:'web_url')
+        self.web_url = attributes[:'web_url']
+      end
+
+      if attributes.key?(:'content_available')
+        self.content_available = attributes[:'content_available']
+      end
+
+      if attributes.key?(:'send_to_inbox')
+        self.send_to_inbox = attributes[:'send_to_inbox']
+      end
+
+      if attributes.key?(:'mutable_content')
+        self.mutable_content = attributes[:'mutable_content']
+      end
+
+      if attributes.key?(:'video_asset_id')
+        self.video_asset_id = attributes[:'video_asset_id']
+      end
+
+      if attributes.key?(:'action_buttons')
+        if (value = attributes[:'action_buttons']).is_a?(Array)
+          self.action_buttons = value
+        end
+      end
+
+      if attributes.key?(:'push_platform_target')
+        self.push_platform_target = attributes[:'push_platform_target']
+      end
+
+      if attributes.key?(:'send_to_primary')
+        self.send_to_primary = attributes[:'send_to_primary']
+      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
+      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?
+      channel_validator = EnumAttributeValidator.new('String', ["push"])
+      return false unless channel_validator.valid?(@channel)
+      badge_config_validator = EnumAttributeValidator.new('String', ["increment-one", "set-count", "set-property"])
+      return false unless badge_config_validator.valid?(@badge_config)
+      push_type_validator = EnumAttributeValidator.new('String', ["silent", "standard"])
+      return false unless push_type_validator.valid?(@push_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] channel Object to be assigned
+    def channel=(channel)
+      validator = EnumAttributeValidator.new('String', ["push"])
+      unless validator.valid?(channel)
+        fail ArgumentError, "invalid value for \"channel\", must be one of #{validator.allowable_values}."
+      end
+      @channel = channel
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] badge_config Object to be assigned
+    def badge_config=(badge_config)
+      validator = EnumAttributeValidator.new('String', ["increment-one", "set-count", "set-property"])
+      unless validator.valid?(badge_config)
+        fail ArgumentError, "invalid value for \"badge_config\", must be one of #{validator.allowable_values}."
+      end
+      @badge_config = badge_config
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] push_type Object to be assigned
+    def push_type=(push_type)
+      validator = EnumAttributeValidator.new('String', ["silent", "standard"])
+      unless validator.valid?(push_type)
+        fail ArgumentError, "invalid value for \"push_type\", must be one of #{validator.allowable_values}."
+      end
+      @push_type = push_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 &&
+          channel == o.channel &&
+          title == o.title &&
+          body == o.body &&
+          badge == o.badge &&
+          badge_config == o.badge_config &&
+          badge_value == o.badge_value &&
+          sound_file_name == o.sound_file_name &&
+          static_asset_id == o.static_asset_id &&
+          sound == o.sound &&
+          open_action == o.open_action &&
+          dynamic_media_template == o.dynamic_media_template &&
+          kv_pairs == o.kv_pairs &&
+          push_type == o.push_type &&
+          ios_deep_link == o.ios_deep_link &&
+          android_deep_link == o.android_deep_link &&
+          web_url == o.web_url &&
+          content_available == o.content_available &&
+          send_to_inbox == o.send_to_inbox &&
+          mutable_content == o.mutable_content &&
+          video_asset_id == o.video_asset_id &&
+          action_buttons == o.action_buttons &&
+          push_platform_target == o.push_platform_target &&
+          send_to_primary == o.send_to_primary
+    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
+      [channel, title, body, badge, badge_config, badge_value, sound_file_name, static_asset_id, sound, open_action, dynamic_media_template, kv_pairs, push_type, ios_deep_link, android_deep_link, web_url, content_available, send_to_inbox, mutable_content, video_asset_id, action_buttons, push_platform_target, send_to_primary].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      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 = KlaviyoAPI.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

data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb

@@ -21,12 +21,15 @@ module KlaviyoAPI
 
     attr_accessor :attributes
 
+    attr_accessor :meta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'type' => :'type',
         :'id' => :'id',
-        :'attributes' => :'attributes'
+        :'attributes' => :'attributes',
+        :'meta' => :'meta'
       }
     end
 
@@ -40,7 +43,8 @@ module KlaviyoAPI
       {
         :'type' => :'ProfileEnum',
         :'id' => :'String',
-        :'attributes' => :'PushProfileUpsertQueryResourceObjectAttributes'
+        :'attributes' => :'PushProfileUpsertQueryResourceObjectAttributes',
+        :'meta' => :'ProfileMeta'
       }
     end
 
@@ -77,6 +81,10 @@ module KlaviyoAPI
       if attributes.key?(:'attributes')
         self.attributes = attributes[:'attributes']
       end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -109,7 +117,8 @@ module KlaviyoAPI
       self.class == o.class &&
           type == o.type &&
           id == o.id &&
-          attributes == o.attributes
+          attributes == o.attributes &&
+          meta == o.meta
     end
 
     # @see the `==` method
@@ -121,7 +130,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, id, attributes].hash
+      [type, id, attributes, meta].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb

@@ -46,8 +46,6 @@ module KlaviyoAPI
     # An object containing key/value pairs for any custom properties assigned to this profile
     attr_accessor :properties
 
-    attr_accessor :meta
-
     # Individual's email address
     attr_accessor :email
 
@@ -65,7 +63,6 @@ module KlaviyoAPI
         :'image' => :'image',
         :'location' => :'location',
         :'properties' => :'properties',
-        :'meta' => :'meta',
         :'email' => :'email'
       }
     end
@@ -89,7 +86,6 @@ module KlaviyoAPI
         :'image' => :'String',
         :'location' => :'ProfileLocation',
         :'properties' => :'Object',
-        :'meta' => :'ProfileMeta',
         :'email' => :'String'
       }
     end
@@ -170,10 +166,6 @@ module KlaviyoAPI
         self.properties = attributes[:'properties']
       end
 
-      if attributes.key?(:'meta')
-        self.meta = attributes[:'meta']
-      end
-
       if attributes.key?(:'email')
         self.email = attributes[:'email']
       end
@@ -208,7 +200,6 @@ module KlaviyoAPI
           image == o.image &&
           location == o.location &&
           properties == o.properties &&
-          meta == o.meta &&
           email == o.email
     end
 
@@ -221,7 +212,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [phone_number, external_id, _kx, first_name, last_name, organization, locale, title, image, location, properties, meta, email].hash
+      [phone_number, external_id, _kx, first_name, last_name, organization, locale, title, image, location, properties, email].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb

@@ -18,6 +18,8 @@ module KlaviyoAPI
 
     attr_accessor :classname
 
+    attr_accessor :block_animation
+
     attr_accessor :property_name
 
     attr_accessor :label
@@ -59,6 +61,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'display_device',
         :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'property_name' => :'property_name',
         :'label' => :'label',
         :'show_label' => :'show_label',
@@ -79,6 +82,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'Array<String>',
         :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'property_name' => :'String',
         :'label' => :'String',
         :'show_label' => :'Boolean',
@@ -124,6 +128,10 @@ module KlaviyoAPI
         self.classname = attributes[:'classname']
       end
 
+      if attributes.key?(:'block_animation')
+        self.block_animation = attributes[:'block_animation']
+      end
+
       if attributes.key?(:'property_name')
         self.property_name = attributes[:'property_name']
       end
@@ -189,6 +197,7 @@ module KlaviyoAPI
       self.class == o.class &&
           display_device == o.display_device &&
           classname == o.classname &&
+          block_animation == o.block_animation &&
           property_name == o.property_name &&
           label == o.label &&
           show_label == o.show_label &&
@@ -207,7 +216,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, classname, property_name, label, show_label, required, error_messages, options, placeholder].hash
+      [display_device, classname, block_animation, property_name, label, show_label, required, error_messages, options, placeholder].hash
     end
 
     # Builds the object from hash