klaviyo-api-sdk 17.0.0 → 19.0.0

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

@@ -0,0 +1,305 @@
+=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 IafDeeplinkToScreen
+    # Not allowed on create.
+    attr_accessor :id
+
+    attr_accessor :submit
+
+    attr_accessor :type
+
+    attr_accessor :properties
+
+    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
+      {
+        :'id' => :'id',
+        :'submit' => :'submit',
+        :'type' => :'type',
+        :'properties' => :'properties'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'submit' => :'Boolean',
+        :'type' => :'String',
+        :'properties' => :'IafDeeplinkToScreenProperties'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id',
+      ])
+    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::IafDeeplinkToScreen` 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::IafDeeplinkToScreen`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'submit')
+        self.submit = attributes[:'submit']
+      else
+        self.submit = true
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'properties')
+        self.properties = attributes[:'properties']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @properties.nil?
+        invalid_properties.push('invalid value for "properties", properties 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?
+      submit_validator = EnumAttributeValidator.new('Boolean', ["true"])
+      return false unless submit_validator.valid?(@submit)
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["iaf_deeplink_to_screen"])
+      return false unless type_validator.valid?(@type)
+      return false if @properties.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] submit Object to be assigned
+    def submit=(submit)
+      validator = EnumAttributeValidator.new('Boolean', ["true"])
+      unless validator.valid?(submit)
+        fail ArgumentError, "invalid value for \"submit\", must be one of #{validator.allowable_values}."
+      end
+      @submit = submit
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["iaf_deeplink_to_screen"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = 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 &&
+          id == o.id &&
+          submit == o.submit &&
+          type == o.type &&
+          properties == o.properties
+    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
+      [id, submit, type, properties].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/{render_options.rb → iaf_deeplink_to_screen_properties.rb}

@@ -13,22 +13,22 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class RenderOptions
-    attr_accessor :shorten_links
+  class IafDeeplinkToScreenProperties
+    attr_accessor :deep_link_url
 
-    attr_accessor :add_org_prefix
+    attr_accessor :deep_link_url_ios
 
-    attr_accessor :add_info_link
+    attr_accessor :deep_link_url_android
 
-    attr_accessor :add_opt_out_language
+    attr_accessor :use_separate_deep_link_urls
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'shorten_links' => :'shorten_links',
-        :'add_org_prefix' => :'add_org_prefix',
-        :'add_info_link' => :'add_info_link',
-        :'add_opt_out_language' => :'add_opt_out_language'
+        :'deep_link_url' => :'deep_link_url',
+        :'deep_link_url_ios' => :'deep_link_url_ios',
+        :'deep_link_url_android' => :'deep_link_url_android',
+        :'use_separate_deep_link_urls' => :'use_separate_deep_link_urls'
       }
     end
 
@@ -40,20 +40,17 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'shorten_links' => :'Boolean',
-        :'add_org_prefix' => :'Boolean',
-        :'add_info_link' => :'Boolean',
-        :'add_opt_out_language' => :'Boolean'
+        :'deep_link_url' => :'String',
+        :'deep_link_url_ios' => :'String',
+        :'deep_link_url_android' => :'String',
+        :'use_separate_deep_link_urls' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'shorten_links',
-        :'add_org_prefix',
-        :'add_info_link',
-        :'add_opt_out_language'
+        :'use_separate_deep_link_urls'
       ])
     end
 
@@ -61,39 +58,37 @@ 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::RenderOptions` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::IafDeeplinkToScreenProperties` 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::RenderOptions`. 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::IafDeeplinkToScreenProperties`. 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?(:'shorten_links')
-        self.shorten_links = attributes[:'shorten_links']
+      if attributes.key?(:'deep_link_url')
+        self.deep_link_url = attributes[:'deep_link_url']
       else
-        self.shorten_links = true
+        self.deep_link_url = ''
       end
 
-      if attributes.key?(:'add_org_prefix')
-        self.add_org_prefix = attributes[:'add_org_prefix']
+      if attributes.key?(:'deep_link_url_ios')
+        self.deep_link_url_ios = attributes[:'deep_link_url_ios']
       else
-        self.add_org_prefix = true
+        self.deep_link_url_ios = ''
       end
 
-      if attributes.key?(:'add_info_link')
-        self.add_info_link = attributes[:'add_info_link']
+      if attributes.key?(:'deep_link_url_android')
+        self.deep_link_url_android = attributes[:'deep_link_url_android']
       else
-        self.add_info_link = true
+        self.deep_link_url_android = ''
       end
 
-      if attributes.key?(:'add_opt_out_language')
-        self.add_opt_out_language = attributes[:'add_opt_out_language']
-      else
-        self.add_opt_out_language = false
+      if attributes.key?(:'use_separate_deep_link_urls')
+        self.use_separate_deep_link_urls = attributes[:'use_separate_deep_link_urls']
       end
     end
 
@@ -115,10 +110,10 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          shorten_links == o.shorten_links &&
-          add_org_prefix == o.add_org_prefix &&
-          add_info_link == o.add_info_link &&
-          add_opt_out_language == o.add_opt_out_language
+          deep_link_url == o.deep_link_url &&
+          deep_link_url_ios == o.deep_link_url_ios &&
+          deep_link_url_android == o.deep_link_url_android &&
+          use_separate_deep_link_urls == o.use_separate_deep_link_urls
     end
 
     # @see the `==` method
@@ -130,7 +125,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [shorten_links, add_org_prefix, add_info_link, add_opt_out_language].hash
+      [deep_link_url, deep_link_url_ios, deep_link_url_android, use_separate_deep_link_urls].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{text_block_v0.rb → iaf_open_url.rb}

@@ -13,12 +13,15 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class TextBlockV0
-    attr_accessor :content_type
+  class IafOpenUrl
+    # Not allowed on create.
+    attr_accessor :id
+
+    attr_accessor :submit
 
     attr_accessor :type
 
-    attr_accessor :data
+    attr_accessor :properties
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -45,9 +48,10 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'content_type' => :'content_type',
+        :'id' => :'id',
+        :'submit' => :'submit',
         :'type' => :'type',
-        :'data' => :'data'
+        :'properties' => :'properties'
       }
     end
 
@@ -59,15 +63,17 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'content_type' => :'String',
+        :'id' => :'String',
+        :'submit' => :'Boolean',
         :'type' => :'String',
-        :'data' => :'TextBlockDataV0'
+        :'properties' => :'IafOpenUrlProperties'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'id',
       ])
     end
 
@@ -75,27 +81,33 @@ 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::TextBlockV0` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::IafOpenUrl` 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::TextBlockV0`. 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::IafOpenUrl`. 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?(:'content_type')
-        self.content_type = attributes[:'content_type']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'submit')
+        self.submit = attributes[:'submit']
+      else
+        self.submit = true
       end
 
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
 
-      if attributes.key?(:'data')
-        self.data = attributes[:'data']
+      if attributes.key?(:'properties')
+        self.properties = attributes[:'properties']
       end
     end
 
@@ -103,16 +115,12 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @content_type.nil?
-        invalid_properties.push('invalid value for "content_type", content_type cannot be nil.')
-      end
-
       if @type.nil?
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
-      if @data.nil?
-        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      if @properties.nil?
+        invalid_properties.push('invalid value for "properties", properties cannot be nil.')
       end
 
       invalid_properties
@@ -121,30 +129,29 @@ module KlaviyoAPI
     # 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 @content_type.nil?
-      content_type_validator = EnumAttributeValidator.new('String', ["block"])
-      return false unless content_type_validator.valid?(@content_type)
+      submit_validator = EnumAttributeValidator.new('Boolean', ["true"])
+      return false unless submit_validator.valid?(@submit)
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["text"])
+      type_validator = EnumAttributeValidator.new('String', ["iaf_open_url"])
       return false unless type_validator.valid?(@type)
-      return false if @data.nil?
+      return false if @properties.nil?
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] content_type Object to be assigned
-    def content_type=(content_type)
-      validator = EnumAttributeValidator.new('String', ["block"])
-      unless validator.valid?(content_type)
-        fail ArgumentError, "invalid value for \"content_type\", must be one of #{validator.allowable_values}."
+    # @param [Object] submit Object to be assigned
+    def submit=(submit)
+      validator = EnumAttributeValidator.new('Boolean', ["true"])
+      unless validator.valid?(submit)
+        fail ArgumentError, "invalid value for \"submit\", must be one of #{validator.allowable_values}."
       end
-      @content_type = content_type
+      @submit = submit
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["text"])
+      validator = EnumAttributeValidator.new('String', ["iaf_open_url"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -156,9 +163,10 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          content_type == o.content_type &&
+          id == o.id &&
+          submit == o.submit &&
           type == o.type &&
-          data == o.data
+          properties == o.properties
     end
 
     # @see the `==` method
@@ -170,7 +178,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content_type, type, data].hash
+      [id, submit, type, properties].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/{sms_content_create.rb → iaf_open_url_properties.rb}

@@ -13,14 +13,13 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class SMSContentCreate
-    # The message body
-    attr_accessor :body
+  class IafOpenUrlProperties
+    attr_accessor :web_url
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'body' => :'body'
+        :'web_url' => :'web_url'
       }
     end
 
@@ -32,14 +31,13 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'body' => :'String'
+        :'web_url' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'body'
       ])
     end
 
@@ -47,19 +45,21 @@ 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::SMSContentCreate` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::IafOpenUrlProperties` 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::SMSContentCreate`. 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::IafOpenUrlProperties`. 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?(:'body')
-        self.body = attributes[:'body']
+      if attributes.key?(:'web_url')
+        self.web_url = attributes[:'web_url']
+      else
+        self.web_url = ''
       end
     end
 
@@ -81,7 +81,7 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          body == o.body
+          web_url == o.web_url
     end
 
     # @see the `==` method
@@ -93,7 +93,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [body].hash
+      [web_url].hash
     end
 
     # Builds the object from hash