klaviyo-api-sdk 18.0.0 → 19.0.0

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

@@ -21,6 +21,7 @@ module KlaviyoAPI
           :'Close',
           :'GoToInbox',
           :'IafDeeplinkToScreen',
+          :'IafOpenUrl',
           :'NextStep',
           :'OpenForm',
           :'PromotionalSMSSubscription',

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

@@ -18,6 +18,8 @@ module KlaviyoAPI
 
     attr_accessor :classname
 
+    attr_accessor :block_animation
+
     attr_accessor :label
 
     attr_accessor :additional_fields
@@ -49,6 +51,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'display_device',
         :'classname' => :'classname',
+        :'block_animation' => :'block_animation',
         :'label' => :'label',
         :'additional_fields' => :'additional_fields'
       }
@@ -64,6 +67,7 @@ module KlaviyoAPI
       {
         :'display_device' => :'Array<String>',
         :'classname' => :'String',
+        :'block_animation' => :'Animation',
         :'label' => :'String',
         :'additional_fields' => :'Array<AdditionalField>'
       }
@@ -102,6 +106,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
@@ -138,6 +146,7 @@ module KlaviyoAPI
       self.class == o.class &&
           display_device == o.display_device &&
           classname == o.classname &&
+          block_animation == o.block_animation &&
           label == o.label &&
           additional_fields == o.additional_fields
     end
@@ -151,7 +160,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_device, classname, label, additional_fields].hash
+      [display_device, classname, block_animation, label, additional_fields].hash
     end
 
     # Builds the object from hash

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

@@ -21,6 +21,8 @@ module KlaviyoAPI
     # Valid button block widths.
     attr_accessor :width
 
+    attr_accessor :inner_padding
+
     attr_accessor :height
 
     # Horizontal alignment enumeration.
@@ -66,6 +68,7 @@ module KlaviyoAPI
         :'padding' => :'padding',
         :'background_color' => :'background_color',
         :'width' => :'width',
+        :'inner_padding' => :'inner_padding',
         :'height' => :'height',
         :'alignment' => :'alignment',
         :'hover_background_color' => :'hover_background_color',
@@ -88,6 +91,7 @@ module KlaviyoAPI
         :'padding' => :'Padding',
         :'background_color' => :'String',
         :'width' => :'String',
+        :'inner_padding' => :'Padding',
         :'height' => :'ButtonStylesHeight',
         :'alignment' => :'String',
         :'hover_background_color' => :'String',
@@ -138,6 +142,10 @@ module KlaviyoAPI
         self.width = 'fill'
       end
 
+      if attributes.key?(:'inner_padding')
+        self.inner_padding = attributes[:'inner_padding']
+      end
+
       if attributes.key?(:'height')
         self.height = attributes[:'height']
       end
@@ -218,6 +226,7 @@ module KlaviyoAPI
           padding == o.padding &&
           background_color == o.background_color &&
           width == o.width &&
+          inner_padding == o.inner_padding &&
           height == o.height &&
           alignment == o.alignment &&
           hover_background_color == o.hover_background_color &&
@@ -237,7 +246,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [padding, background_color, width, height, alignment, hover_background_color, hover_text_color, border_styles, text_styles, color, drop_shadow].hash
+      [padding, background_color, width, inner_padding, height, alignment, hover_background_color, hover_text_color, border_styles, text_styles, color, drop_shadow].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,35 @@
+=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 CampaignAudienceCloneEnum
+    CAMPAIGN_AUDIENCE_CLONE = "campaign-audience-clone".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = CampaignAudienceCloneEnum.constants.select { |c| CampaignAudienceCloneEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #CampaignAudienceCloneEnum" if constantValues.empty?
+      value
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+=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 CampaignAudienceEnum
+    CAMPAIGN_AUDIENCE = "campaign-audience".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = CampaignAudienceEnum.constants.select { |c| CampaignAudienceEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #CampaignAudienceEnum" if constantValues.empty?
+      value
+    end
+  end
+end

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

@@ -14,13 +14,13 @@ require 'time'
 
 module KlaviyoAPI
   class CampaignCloneQueryResourceObjectAttributes
-    # The name for the new cloned campaign
-    attr_accessor :new_name
+    # Name for the cloned campaign. Defaults to 'Copy of {source name}'.
+    attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'new_name' => :'new_name'
+        :'name' => :'name'
       }
     end
 
@@ -32,14 +32,14 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'new_name' => :'String'
+        :'name' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'new_name'
+        :'name'
       ])
     end
 
@@ -58,8 +58,8 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'new_name')
-        self.new_name = attributes[:'new_name']
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
     end
 
@@ -81,7 +81,7 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          new_name == o.new_name
+          name == o.name
     end
 
     # @see the `==` method
@@ -93,7 +93,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [new_name].hash
+      [name].hash
     end
 
     # Builds the object from hash

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

@@ -18,11 +18,14 @@ module KlaviyoAPI
 
     attr_accessor :attributes
 
+    attr_accessor :relationships
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'type' => :'type',
-        :'attributes' => :'attributes'
+        :'attributes' => :'attributes',
+        :'relationships' => :'relationships'
       }
     end
 
@@ -35,7 +38,8 @@ module KlaviyoAPI
     def self.openapi_types
       {
         :'type' => :'CampaignEnum',
-        :'attributes' => :'CampaignCreateQueryResourceObjectAttributes'
+        :'attributes' => :'CampaignCreateQueryResourceObjectAttributes',
+        :'relationships' => :'CampaignCreateQueryResourceObjectRelationships'
       }
     end
 
@@ -67,6 +71,10 @@ module KlaviyoAPI
       if attributes.key?(:'attributes')
         self.attributes = attributes[:'attributes']
       end
+
+      if attributes.key?(:'relationships')
+        self.relationships = attributes[:'relationships']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -98,7 +106,8 @@ module KlaviyoAPI
       return true if self.equal?(o)
       self.class == o.class &&
           type == o.type &&
-          attributes == o.attributes
+          attributes == o.attributes &&
+          relationships == o.relationships
     end
 
     # @see the `==` method
@@ -110,7 +119,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, attributes].hash
+      [type, attributes, relationships].hash
     end
 
     # Builds the object from hash

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

@@ -14,28 +14,20 @@ require 'time'
 
 module KlaviyoAPI
   class CampaignCreateQueryResourceObjectAttributes
-    # The campaign name
-    attr_accessor :name
+    attr_accessor :definition
 
-    attr_accessor :audiences
-
-    attr_accessor :send_strategy
-
-    attr_accessor :send_options
+    # Messages to create on this campaign. Each references an audience via audience_temporary_id.
+    attr_accessor :messages
 
-    attr_accessor :tracking_options
-
-    attr_accessor :campaign_messages
+    # Audiences to create on this campaign. Each references a message via audience_temporary_id.
+    attr_accessor :audiences
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'name' => :'name',
-        :'audiences' => :'audiences',
-        :'send_strategy' => :'send_strategy',
-        :'send_options' => :'send_options',
-        :'tracking_options' => :'tracking_options',
-        :'campaign_messages' => :'campaign-messages'
+        :'definition' => :'definition',
+        :'messages' => :'messages',
+        :'audiences' => :'audiences'
       }
     end
 
@@ -47,21 +39,17 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'name' => :'String',
-        :'audiences' => :'Audiences',
-        :'send_strategy' => :'CampaignCreateQueryResourceObjectAttributesSendStrategy',
-        :'send_options' => :'CampaignCreateQueryResourceObjectAttributesSendOptions',
-        :'tracking_options' => :'CampaignCreateQueryResourceObjectAttributesTrackingOptions',
-        :'campaign_messages' => :'CampaignCreateQueryResourceObjectAttributesCampaignMessages'
+        :'definition' => :'CampaignDefinition',
+        :'messages' => :'Array<MessageInlineCreate>',
+        :'audiences' => :'Array<AudienceInlineCreate>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'send_strategy',
-        :'send_options',
-        :'tracking_options',
+        :'messages',
+        :'audiences'
       ])
     end
 
@@ -80,28 +68,20 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      end
-
-      if attributes.key?(:'audiences')
-        self.audiences = attributes[:'audiences']
-      end
-
-      if attributes.key?(:'send_strategy')
-        self.send_strategy = attributes[:'send_strategy']
+      if attributes.key?(:'definition')
+        self.definition = attributes[:'definition']
       end
 
-      if attributes.key?(:'send_options')
-        self.send_options = attributes[:'send_options']
-      end
-
-      if attributes.key?(:'tracking_options')
-        self.tracking_options = attributes[:'tracking_options']
+      if attributes.key?(:'messages')
+        if (value = attributes[:'messages']).is_a?(Array)
+          self.messages = value
+        end
       end
 
-      if attributes.key?(:'campaign_messages')
-        self.campaign_messages = attributes[:'campaign_messages']
+      if attributes.key?(:'audiences')
+        if (value = attributes[:'audiences']).is_a?(Array)
+          self.audiences = value
+        end
       end
     end
 
@@ -109,16 +89,8 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
-      end
-
-      if @audiences.nil?
-        invalid_properties.push('invalid value for "audiences", audiences cannot be nil.')
-      end
-
-      if @campaign_messages.nil?
-        invalid_properties.push('invalid value for "campaign_messages", campaign_messages cannot be nil.')
+      if @definition.nil?
+        invalid_properties.push('invalid value for "definition", definition cannot be nil.')
       end
 
       invalid_properties
@@ -127,9 +99,7 @@ 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 @name.nil?
-      return false if @audiences.nil?
-      return false if @campaign_messages.nil?
+      return false if @definition.nil?
       true
     end
 
@@ -138,12 +108,9 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          name == o.name &&
-          audiences == o.audiences &&
-          send_strategy == o.send_strategy &&
-          send_options == o.send_options &&
-          tracking_options == o.tracking_options &&
-          campaign_messages == o.campaign_messages
+          definition == o.definition &&
+          messages == o.messages &&
+          audiences == o.audiences
     end
 
     # @see the `==` method
@@ -155,7 +122,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, audiences, send_strategy, send_options, tracking_options, campaign_messages].hash
+      [definition, messages, audiences].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,236 @@
+=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 CampaignCreateQueryResourceObjectRelationships
+    attr_accessor :campaign_audiences
+
+    attr_accessor :campaign_messages
+
+    attr_accessor :tags
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'campaign_audiences' => :'campaign-audiences',
+        :'campaign_messages' => :'campaign-messages',
+        :'tags' => :'tags'
+      }
+    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
+      {
+        :'campaign_audiences' => :'CampaignCreateQueryResourceObjectRelationshipsCampaignAudiences',
+        :'campaign_messages' => :'CampaignCreateQueryResourceObjectRelationshipsCampaignMessages',
+        :'tags' => :'CampaignCreateQueryResourceObjectRelationshipsTags'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::CampaignCreateQueryResourceObjectRelationships` 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::CampaignCreateQueryResourceObjectRelationships`. 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?(:'campaign_audiences')
+        self.campaign_audiences = attributes[:'campaign_audiences']
+      end
+
+      if attributes.key?(:'campaign_messages')
+        self.campaign_messages = attributes[:'campaign_messages']
+      end
+
+      if attributes.key?(:'tags')
+        self.tags = attributes[:'tags']
+      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 &&
+          campaign_audiences == o.campaign_audiences &&
+          campaign_messages == o.campaign_messages &&
+          tags == o.tags
+    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
+      [campaign_audiences, campaign_messages, tags].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