klaviyo-api-sdk 18.0.0 → 19.0.0

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

@@ -0,0 +1,242 @@
+=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 SlimImageReference
+    # ID of the static image asset when the card uses a library image.
+    attr_accessor :static_image_asset_id
+
+    # Dynamic image template (e.g. Django tags) for the card image.
+    attr_accessor :dynamic_image_template
+
+    # Pre-rendered image URL when available.
+    attr_accessor :rendered_asset_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'static_image_asset_id' => :'static_image_asset_id',
+        :'dynamic_image_template' => :'dynamic_image_template',
+        :'rendered_asset_url' => :'rendered_asset_url'
+      }
+    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
+      {
+        :'static_image_asset_id' => :'Integer',
+        :'dynamic_image_template' => :'String',
+        :'rendered_asset_url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'static_image_asset_id',
+        :'dynamic_image_template',
+        :'rendered_asset_url'
+      ])
+    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::SlimImageReference` 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::SlimImageReference`. 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?(:'static_image_asset_id')
+        self.static_image_asset_id = attributes[:'static_image_asset_id']
+      end
+
+      if attributes.key?(:'dynamic_image_template')
+        self.dynamic_image_template = attributes[:'dynamic_image_template']
+      end
+
+      if attributes.key?(:'rendered_asset_url')
+        self.rendered_asset_url = attributes[:'rendered_asset_url']
+      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?
+      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 &&
+          static_image_asset_id == o.static_image_asset_id &&
+          dynamic_image_template == o.dynamic_image_template &&
+          rendered_asset_url == o.rendered_asset_url
+    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
+      [static_image_asset_id, dynamic_image_template, rendered_asset_url].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/{mobile_push_message_silent_definition_update.rb → sms_channel_details.rb}

@@ -13,14 +13,34 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class MobilePushMessageSilentDefinitionUpdate
+  class SMSChannelDetails
     attr_accessor :channel
 
-    # The key-value pairs to be sent with the push notification
-    attr_accessor :kv_pairs
+    attr_accessor :template_id
 
-    # The type of notification to send
-    attr_accessor :notification_type
+    # Not allowed on create.
+    attr_accessor :cost
+
+    attr_accessor :mms_static_image_asset_id
+
+    attr_accessor :shorten_links
+
+    attr_accessor :include_contact_card
+
+    attr_accessor :body
+
+    attr_accessor :add_org_prefix
+
+    attr_accessor :add_info_link
+
+    attr_accessor :add_opt_out_language
+
+    attr_accessor :mms_dynamic_image_template
+
+    # A sms message variation's text message type.  Values match the Django OmniSMSTextMessageType (MESSAGE_FORMAT_*)     constants.
+    attr_accessor :text_message_type
+
+    attr_accessor :message_hierarchy
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -48,8 +68,18 @@ module KlaviyoAPI
     def self.attribute_map
       {
         :'channel' => :'channel',
-        :'kv_pairs' => :'kv_pairs',
-        :'notification_type' => :'notification_type'
+        :'template_id' => :'template_id',
+        :'cost' => :'cost',
+        :'mms_static_image_asset_id' => :'mms_static_image_asset_id',
+        :'shorten_links' => :'shorten_links',
+        :'include_contact_card' => :'include_contact_card',
+        :'body' => :'body',
+        :'add_org_prefix' => :'add_org_prefix',
+        :'add_info_link' => :'add_info_link',
+        :'add_opt_out_language' => :'add_opt_out_language',
+        :'mms_dynamic_image_template' => :'mms_dynamic_image_template',
+        :'text_message_type' => :'text_message_type',
+        :'message_hierarchy' => :'message_hierarchy'
       }
     end
 
@@ -62,14 +92,34 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'channel' => :'String',
-        :'kv_pairs' => :'Object',
-        :'notification_type' => :'String'
+        :'template_id' => :'String',
+        :'cost' => :'Float',
+        :'mms_static_image_asset_id' => :'Integer',
+        :'shorten_links' => :'Boolean',
+        :'include_contact_card' => :'Boolean',
+        :'body' => :'String',
+        :'add_org_prefix' => :'Boolean',
+        :'add_info_link' => :'Boolean',
+        :'add_opt_out_language' => :'Boolean',
+        :'mms_dynamic_image_template' => :'String',
+        :'text_message_type' => :'String',
+        :'message_hierarchy' => :'Array<FlowSmsMessageHierarchyInner>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'template_id',
+        :'cost',
+        :'mms_static_image_asset_id',
+        :'shorten_links',
+        :'include_contact_card',
+        :'add_org_prefix',
+        :'add_info_link',
+        :'add_opt_out_language',
+        :'mms_dynamic_image_template',
+        :'message_hierarchy'
       ])
     end
 
@@ -77,29 +127,75 @@ 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::MobilePushMessageSilentDefinitionUpdate` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::SMSChannelDetails` 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::MobilePushMessageSilentDefinitionUpdate`. 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::SMSChannelDetails`. 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 = 'sms'
       end
 
-      if attributes.key?(:'kv_pairs')
-        self.kv_pairs = attributes[:'kv_pairs']
+      if attributes.key?(:'template_id')
+        self.template_id = attributes[:'template_id']
       end
 
-      if attributes.key?(:'notification_type')
-        self.notification_type = attributes[:'notification_type']
+      if attributes.key?(:'cost')
+        self.cost = attributes[:'cost']
+      end
+
+      if attributes.key?(:'mms_static_image_asset_id')
+        self.mms_static_image_asset_id = attributes[:'mms_static_image_asset_id']
+      end
+
+      if attributes.key?(:'shorten_links')
+        self.shorten_links = attributes[:'shorten_links']
+      end
+
+      if attributes.key?(:'include_contact_card')
+        self.include_contact_card = attributes[:'include_contact_card']
+      end
+
+      if attributes.key?(:'body')
+        self.body = attributes[:'body']
       else
-        self.notification_type = 'silent'
+        self.body = ''
+      end
+
+      if attributes.key?(:'add_org_prefix')
+        self.add_org_prefix = attributes[:'add_org_prefix']
+      end
+
+      if attributes.key?(:'add_info_link')
+        self.add_info_link = attributes[:'add_info_link']
+      end
+
+      if attributes.key?(:'add_opt_out_language')
+        self.add_opt_out_language = attributes[:'add_opt_out_language']
+      end
+
+      if attributes.key?(:'mms_dynamic_image_template')
+        self.mms_dynamic_image_template = attributes[:'mms_dynamic_image_template']
+      end
+
+      if attributes.key?(:'text_message_type')
+        self.text_message_type = attributes[:'text_message_type']
+      else
+        self.text_message_type = 'SMS'
+      end
+
+      if attributes.key?(:'message_hierarchy')
+        if (value = attributes[:'message_hierarchy']).is_a?(Array)
+          self.message_hierarchy = value
+        end
       end
     end
 
@@ -107,28 +203,23 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @channel.nil?
-        invalid_properties.push('invalid value for "channel", channel 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 @channel.nil?
-      channel_validator = EnumAttributeValidator.new('String', ["mobile_push"])
+      channel_validator = EnumAttributeValidator.new('String', ["sms"])
       return false unless channel_validator.valid?(@channel)
-      notification_type_validator = EnumAttributeValidator.new('String', ["silent"])
-      return false unless notification_type_validator.valid?(@notification_type)
+      text_message_type_validator = EnumAttributeValidator.new('String', ["MMS", "RCS", "SMS"])
+      return false unless text_message_type_validator.valid?(@text_message_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', ["mobile_push"])
+      validator = EnumAttributeValidator.new('String', ["sms"])
       unless validator.valid?(channel)
         fail ArgumentError, "invalid value for \"channel\", must be one of #{validator.allowable_values}."
       end
@@ -136,13 +227,13 @@ module KlaviyoAPI
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] notification_type Object to be assigned
-    def notification_type=(notification_type)
-      validator = EnumAttributeValidator.new('String', ["silent"])
-      unless validator.valid?(notification_type)
-        fail ArgumentError, "invalid value for \"notification_type\", must be one of #{validator.allowable_values}."
+    # @param [Object] text_message_type Object to be assigned
+    def text_message_type=(text_message_type)
+      validator = EnumAttributeValidator.new('String', ["MMS", "RCS", "SMS"])
+      unless validator.valid?(text_message_type)
+        fail ArgumentError, "invalid value for \"text_message_type\", must be one of #{validator.allowable_values}."
       end
-      @notification_type = notification_type
+      @text_message_type = text_message_type
     end
 
     # Checks equality by comparing each attribute.
@@ -151,8 +242,18 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           channel == o.channel &&
-          kv_pairs == o.kv_pairs &&
-          notification_type == o.notification_type
+          template_id == o.template_id &&
+          cost == o.cost &&
+          mms_static_image_asset_id == o.mms_static_image_asset_id &&
+          shorten_links == o.shorten_links &&
+          include_contact_card == o.include_contact_card &&
+          body == o.body &&
+          add_org_prefix == o.add_org_prefix &&
+          add_info_link == o.add_info_link &&
+          add_opt_out_language == o.add_opt_out_language &&
+          mms_dynamic_image_template == o.mms_dynamic_image_template &&
+          text_message_type == o.text_message_type &&
+          message_hierarchy == o.message_hierarchy
     end
 
     # @see the `==` method
@@ -164,7 +265,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [channel, kv_pairs, notification_type].hash
+      [channel, template_id, cost, mms_static_image_asset_id, shorten_links, include_contact_card, body, add_org_prefix, add_info_link, add_opt_out_language, mms_dynamic_image_template, text_message_type, message_hierarchy].hash
     end
 
     # Builds the object from hash

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

@@ -18,6 +18,8 @@ module KlaviyoAPI
 
     attr_accessor :classname
 
+    attr_accessor :block_animation
+
     attr_accessor :label
 
     attr_accessor :show_label
@@ -61,6 +63,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'display_device',
         :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'label' => :'label',
         :'show_label' => :'show_label',
         :'error_messages' => :'error_messages',
@@ -82,6 +85,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'Array<String>',
         :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'label' => :'String',
         :'show_label' => :'Boolean',
         :'error_messages' => :'ErrorMessages',
@@ -126,6 +130,10 @@ module KlaviyoAPI
         self.classname = attributes[:'classname']
       end
 
+      if attributes.key?(:'block_animation')
+        self.block_animation = attributes[:'block_animation']
+      end
+
       if attributes.key?(:'label')
         self.label = attributes[:'label']
       end
@@ -228,6 +236,7 @@ module KlaviyoAPI
       self.class == o.class &&
           display_device == o.display_device &&
           classname == o.classname &&
+          block_animation == o.block_animation &&
           label == o.label &&
           show_label == o.show_label &&
           error_messages == o.error_messages &&
@@ -247,7 +256,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, classname, label, show_label, error_messages, required, property_name, checkbox_text, placeholder, channels].hash
+      [display_device, classname, block_animation, label, show_label, error_messages, required, property_name, checkbox_text, placeholder, channels].hash
     end
 
     # Builds the object from hash

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

@@ -18,6 +18,8 @@ module KlaviyoAPI
 
     attr_accessor :background_color
 
+    attr_accessor :input_styles
+
     # Horizontal alignment enumeration.
     attr_accessor :horizontal_alignment
 
@@ -48,6 +50,7 @@ module KlaviyoAPI
       {
         :'padding' => :'padding',
         :'background_color' => :'background_color',
+        :'input_styles' => :'input_styles',
         :'horizontal_alignment' => :'horizontal_alignment'
       }
     end
@@ -62,6 +65,7 @@ module KlaviyoAPI
       {
         :'padding' => :'Padding',
         :'background_color' => :'String',
+        :'input_styles' => :'InputStyleOverrides',
         :'horizontal_alignment' => :'String'
       }
     end
@@ -96,6 +100,10 @@ module KlaviyoAPI
         self.background_color = attributes[:'background_color']
       end
 
+      if attributes.key?(:'input_styles')
+        self.input_styles = attributes[:'input_styles']
+      end
+
       if attributes.key?(:'horizontal_alignment')
         self.horizontal_alignment = attributes[:'horizontal_alignment']
       else
@@ -135,6 +143,7 @@ module KlaviyoAPI
       self.class == o.class &&
           padding == o.padding &&
           background_color == o.background_color &&
+          input_styles == o.input_styles &&
           horizontal_alignment == o.horizontal_alignment
     end
 
@@ -147,7 +156,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [padding, background_color, horizontal_alignment].hash
+      [padding, background_color, input_styles, horizontal_alignment].hash
     end
 
     # Builds the object from hash

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

@@ -18,6 +18,8 @@ module KlaviyoAPI
 
     attr_accessor :classname
 
+    attr_accessor :block_animation
+
     attr_accessor :content
 
     class EnumAttributeValidator
@@ -47,6 +49,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'display_device',
         :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'content' => :'content'
       }
     end
@@ -61,6 +64,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'Array<String>',
         :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'content' => :'SMSDisclosurePropertiesContent'
       }
     end
@@ -97,6 +101,10 @@ module KlaviyoAPI
         self.classname = attributes[:'classname']
       end
 
+      if attributes.key?(:'block_animation')
+        self.block_animation = attributes[:'block_animation']
+      end
+
       if attributes.key?(:'content')
         self.content = attributes[:'content']
       end
@@ -122,6 +130,7 @@ module KlaviyoAPI
       self.class == o.class &&
           display_device == o.display_device &&
           classname == o.classname &&
+          block_animation == o.block_animation &&
           content == o.content
     end
 
@@ -134,7 +143,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, classname, content].hash
+      [display_device, classname, block_animation, content].hash
     end
 
     # Builds the object from hash