klaviyo-api-sdk 18.0.0 → 19.0.0

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

@@ -0,0 +1,322 @@
+=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 PushActionButtonV0
+    attr_accessor :label
+
+    # The action type for a push notification action button.
+    attr_accessor :action_type
+
+    attr_accessor :url
+
+    attr_accessor :icon
+
+    attr_accessor :custom_action_id
+
+    attr_accessor :ios_deep_link
+
+    attr_accessor :android_deep_link
+
+    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
+      {
+        :'label' => :'label',
+        :'action_type' => :'action_type',
+        :'url' => :'url',
+        :'icon' => :'icon',
+        :'custom_action_id' => :'custom_action_id',
+        :'ios_deep_link' => :'ios_deep_link',
+        :'android_deep_link' => :'android_deep_link'
+      }
+    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
+      {
+        :'label' => :'String',
+        :'action_type' => :'String',
+        :'url' => :'String',
+        :'icon' => :'String',
+        :'custom_action_id' => :'String',
+        :'ios_deep_link' => :'String',
+        :'android_deep_link' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'url',
+        :'icon',
+        :'custom_action_id',
+        :'ios_deep_link',
+        :'android_deep_link'
+      ])
+    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::PushActionButtonV0` 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::PushActionButtonV0`. 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?(:'label')
+        self.label = attributes[:'label']
+      end
+
+      if attributes.key?(:'action_type')
+        self.action_type = attributes[:'action_type']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'icon')
+        self.icon = attributes[:'icon']
+      end
+
+      if attributes.key?(:'custom_action_id')
+        self.custom_action_id = attributes[:'custom_action_id']
+      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
+    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
+      if @label.nil?
+        invalid_properties.push('invalid value for "label", label cannot be nil.')
+      end
+
+      if @action_type.nil?
+        invalid_properties.push('invalid value for "action_type", action_type cannot be nil.')
+      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?
+      return false if @label.nil?
+      return false if @action_type.nil?
+      action_type_validator = EnumAttributeValidator.new('String', ["deep_link", "dismiss", "open_app", "open_url"])
+      return false unless action_type_validator.valid?(@action_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action_type Object to be assigned
+    def action_type=(action_type)
+      validator = EnumAttributeValidator.new('String', ["deep_link", "dismiss", "open_app", "open_url"])
+      unless validator.valid?(action_type)
+        fail ArgumentError, "invalid value for \"action_type\", must be one of #{validator.allowable_values}."
+      end
+      @action_type = action_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 &&
+          label == o.label &&
+          action_type == o.action_type &&
+          url == o.url &&
+          icon == o.icon &&
+          custom_action_id == o.custom_action_id &&
+          ios_deep_link == o.ios_deep_link &&
+          android_deep_link == o.android_deep_link
+    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
+      [label, action_type, url, icon, custom_action_id, ios_deep_link, android_deep_link].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_action_button.rb → push_action_button_v2.rb}

@@ -13,7 +13,7 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class PushActionButton
+  class PushActionButtonV2
     attr_accessor :label
 
     # The action type for a push notification action button.
@@ -27,6 +27,10 @@ module KlaviyoAPI
 
     attr_accessor :custom_action_id
 
+    attr_accessor :ios_deep_link
+
+    attr_accessor :android_deep_link
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -57,7 +61,9 @@ module KlaviyoAPI
         :'position' => :'position',
         :'url' => :'url',
         :'icon' => :'icon',
-        :'custom_action_id' => :'custom_action_id'
+        :'custom_action_id' => :'custom_action_id',
+        :'ios_deep_link' => :'ios_deep_link',
+        :'android_deep_link' => :'android_deep_link'
       }
     end
 
@@ -74,7 +80,9 @@ module KlaviyoAPI
         :'position' => :'Integer',
         :'url' => :'String',
         :'icon' => :'String',
-        :'custom_action_id' => :'String'
+        :'custom_action_id' => :'String',
+        :'ios_deep_link' => :'String',
+        :'android_deep_link' => :'String'
       }
     end
 
@@ -84,7 +92,9 @@ module KlaviyoAPI
         :'position',
         :'url',
         :'icon',
-        :'custom_action_id'
+        :'custom_action_id',
+        :'ios_deep_link',
+        :'android_deep_link'
       ])
     end
 
@@ -92,13 +102,13 @@ module KlaviyoAPI
     # @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::PushActionButton` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::PushActionButtonV2` 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::PushActionButton`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `KlaviyoAPI::PushActionButtonV2`. 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
       }
@@ -126,6 +136,14 @@ module KlaviyoAPI
       if attributes.key?(:'custom_action_id')
         self.custom_action_id = attributes[:'custom_action_id']
       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
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -173,7 +191,9 @@ module KlaviyoAPI
           position == o.position &&
           url == o.url &&
           icon == o.icon &&
-          custom_action_id == o.custom_action_id
+          custom_action_id == o.custom_action_id &&
+          ios_deep_link == o.ios_deep_link &&
+          android_deep_link == o.android_deep_link
     end
 
     # @see the `==` method
@@ -185,7 +205,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [label, action_type, position, url, icon, custom_action_id].hash
+      [label, action_type, position, url, icon, custom_action_id, ios_deep_link, android_deep_link].hash
     end
 
     # Builds the object from hash