klaviyo-api-sdk 11.1.0 → 12.0.0

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

@@ -0,0 +1,386 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2025-01-15
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class FlowSms
+    attr_accessor :body
+
+    # The id of an ImageAsset. If provided, this will take precedence over a dynamic_image.
+    attr_accessor :image_id
+
+    # A dynamic image asset to include in the SMS message.
+    attr_accessor :dynamic_image
+
+    attr_accessor :shorten_links
+
+    attr_accessor :include_contact_card
+
+    attr_accessor :add_org_prefix
+
+    attr_accessor :add_info_link
+
+    attr_accessor :add_opt_out_language
+
+    attr_accessor :smart_sending_enabled
+
+    attr_accessor :sms_quiet_hours_enabled
+
+    attr_accessor :transactional
+
+    attr_accessor :add_tracking_params
+
+    attr_accessor :custom_tracking_params
+
+    attr_accessor :additional_filters
+
+    attr_accessor :name
+
+    attr_accessor :id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'body' => :'body',
+        :'image_id' => :'image_id',
+        :'dynamic_image' => :'dynamic_image',
+        :'shorten_links' => :'shorten_links',
+        :'include_contact_card' => :'include_contact_card',
+        :'add_org_prefix' => :'add_org_prefix',
+        :'add_info_link' => :'add_info_link',
+        :'add_opt_out_language' => :'add_opt_out_language',
+        :'smart_sending_enabled' => :'smart_sending_enabled',
+        :'sms_quiet_hours_enabled' => :'sms_quiet_hours_enabled',
+        :'transactional' => :'transactional',
+        :'add_tracking_params' => :'add_tracking_params',
+        :'custom_tracking_params' => :'custom_tracking_params',
+        :'additional_filters' => :'additional_filters',
+        :'name' => :'name',
+        :'id' => :'id'
+      }
+    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
+      {
+        :'body' => :'String',
+        :'image_id' => :'String',
+        :'dynamic_image' => :'String',
+        :'shorten_links' => :'Boolean',
+        :'include_contact_card' => :'Boolean',
+        :'add_org_prefix' => :'Boolean',
+        :'add_info_link' => :'Boolean',
+        :'add_opt_out_language' => :'Boolean',
+        :'smart_sending_enabled' => :'Boolean',
+        :'sms_quiet_hours_enabled' => :'Boolean',
+        :'transactional' => :'Boolean',
+        :'add_tracking_params' => :'Boolean',
+        :'custom_tracking_params' => :'Array<UtmParam>',
+        :'additional_filters' => :'UnionFilter',
+        :'name' => :'String',
+        :'id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'image_id',
+        :'dynamic_image',
+        :'custom_tracking_params',
+        :'name',
+        :'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::FlowSms` 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::FlowSms`. 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']
+      end
+
+      if attributes.key?(:'image_id')
+        self.image_id = attributes[:'image_id']
+      end
+
+      if attributes.key?(:'dynamic_image')
+        self.dynamic_image = attributes[:'dynamic_image']
+      end
+
+      if attributes.key?(:'shorten_links')
+        self.shorten_links = attributes[:'shorten_links']
+      else
+        self.shorten_links = true
+      end
+
+      if attributes.key?(:'include_contact_card')
+        self.include_contact_card = attributes[:'include_contact_card']
+      else
+        self.include_contact_card = false
+      end
+
+      if attributes.key?(:'add_org_prefix')
+        self.add_org_prefix = attributes[:'add_org_prefix']
+      else
+        self.add_org_prefix = true
+      end
+
+      if attributes.key?(:'add_info_link')
+        self.add_info_link = attributes[:'add_info_link']
+      else
+        self.add_info_link = true
+      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
+      end
+
+      if attributes.key?(:'smart_sending_enabled')
+        self.smart_sending_enabled = attributes[:'smart_sending_enabled']
+      else
+        self.smart_sending_enabled = true
+      end
+
+      if attributes.key?(:'sms_quiet_hours_enabled')
+        self.sms_quiet_hours_enabled = attributes[:'sms_quiet_hours_enabled']
+      else
+        self.sms_quiet_hours_enabled = true
+      end
+
+      if attributes.key?(:'transactional')
+        self.transactional = attributes[:'transactional']
+      else
+        self.transactional = false
+      end
+
+      if attributes.key?(:'add_tracking_params')
+        self.add_tracking_params = attributes[:'add_tracking_params']
+      else
+        self.add_tracking_params = false
+      end
+
+      if attributes.key?(:'custom_tracking_params')
+        if (value = attributes[:'custom_tracking_params']).is_a?(Array)
+          self.custom_tracking_params = value
+        end
+      end
+
+      if attributes.key?(:'additional_filters')
+        self.additional_filters = attributes[:'additional_filters']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      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 @body.nil?
+        invalid_properties.push('invalid value for "body", body 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 @body.nil?
+      true
+    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 &&
+          body == o.body &&
+          image_id == o.image_id &&
+          dynamic_image == o.dynamic_image &&
+          shorten_links == o.shorten_links &&
+          include_contact_card == o.include_contact_card &&
+          add_org_prefix == o.add_org_prefix &&
+          add_info_link == o.add_info_link &&
+          add_opt_out_language == o.add_opt_out_language &&
+          smart_sending_enabled == o.smart_sending_enabled &&
+          sms_quiet_hours_enabled == o.sms_quiet_hours_enabled &&
+          transactional == o.transactional &&
+          add_tracking_params == o.add_tracking_params &&
+          custom_tracking_params == o.custom_tracking_params &&
+          additional_filters == o.additional_filters &&
+          name == o.name &&
+          id == o.id
+    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
+      [body, image_id, dynamic_image, shorten_links, include_contact_card, add_org_prefix, add_info_link, add_opt_out_language, smart_sending_enabled, sms_quiet_hours_enabled, transactional, add_tracking_params, custom_tracking_params, additional_filters, name, id].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/flow_tracking_setting_dynamic_param.rb

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2024-10-15
+The version of the OpenAPI document: 2025-01-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -23,7 +23,7 @@ module KlaviyoAPI
     # ID of the metric to be used for conversion statistics
     attr_accessor :conversion_metric_id
 
-    # API filter string used to filter the query. Allowed filters are flow_id, send_channel, flow_message_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. When filtering on send_channel, allowed values are email, push-notification, sms.
+    # API filter string used to filter the query. Allowed filters are flow_id, send_channel, flow_message_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. When filtering on send_channel, allowed values are email, push-notification, sms, whatsapp.
     attr_accessor :filter
 
     class EnumAttributeValidator