klaviyo-api-sdk 1.1.0 → 1.2.0

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

@@ -0,0 +1,228 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2023-02-22
+Contact: developers@klaviyo.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module KlaviyoAPI
+  class GetCampaigns4XXResponseErrorsInnerSource
+    attr_accessor :pointer
+
+    attr_accessor :parameter
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pointer' => :'pointer',
+        :'parameter' => :'parameter'
+      }
+    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
+      {
+        :'pointer' => :'String',
+        :'parameter' => :'String'
+      }
+    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::GetCampaigns4XXResponseErrorsInnerSource` 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::GetCampaigns4XXResponseErrorsInnerSource`. 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?(:'pointer')
+        self.pointer = attributes[:'pointer']
+      end
+
+      if attributes.key?(:'parameter')
+        self.parameter = attributes[:'parameter']
+      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 &&
+          pointer == o.pointer &&
+          parameter == o.parameter
+    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
+      [pointer, parameter].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/included_categories.rb

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -17,7 +17,7 @@ module KlaviyoAPI
   class IncludedCategories
     attr_accessor :type
 
-    # The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`, but support for multiple catalogs  & non-custom integrations is forthcoming.
+    # The catalog category ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
     attr_accessor :id
 
     attr_accessor :attributes

data/lib/klaviyo-api-sdk/models/included_categories_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: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,10 +15,13 @@ require 'time'
 
 module KlaviyoAPI
   class IncludedCategoriesAttributes
+    # The ID of the catalog category in an external system.
     attr_accessor :external_id
 
+    # The name of the catalog category.
     attr_accessor :name
 
+    # Date and time when the catalog category was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).
     attr_accessor :updated
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

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

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

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

data/lib/klaviyo-api-sdk/models/included_flow_actions_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: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

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

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

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

data/lib/klaviyo-api-sdk/models/included_flow_messages_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: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

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

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

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

data/lib/klaviyo-api-sdk/models/included_flows_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: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -17,6 +17,7 @@ module KlaviyoAPI
   class IncludedItems
     attr_accessor :type
 
+    # The catalog item ID is a compound ID (string), with format: `${integration}:::${catalog}:::${external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
     attr_accessor :id
 
     attr_accessor :attributes

data/lib/klaviyo-api-sdk/models/included_items_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: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,26 +15,40 @@ require 'time'
 
 module KlaviyoAPI
   class IncludedItemsAttributes
+    # The ID of the catalog item in an external system.
     attr_accessor :external_id
 
+    # The title of the catalog item.
     attr_accessor :title
 
+    # A description of the catalog item.
     attr_accessor :description
 
+    # This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).
+    attr_accessor :price
+
+    # URL pointing to the location of the catalog item on your website.
     attr_accessor :url
 
+    # URL pointing to the location of a full image of the catalog item.
     attr_accessor :image_full_url
 
+    # URL pointing to the location of an image thumbnail of the catalog item
     attr_accessor :image_thumbnail_url
 
+    # List of URLs pointing to the locations of images of the catalog item.
     attr_accessor :images
 
+    # Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb.
     attr_accessor :custom_metadata
 
+    # Boolean value indicating whether the catalog item is published.
     attr_accessor :published
 
+    # Date and time when the catalog item was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).
     attr_accessor :created
 
+    # Date and time when the catalog item was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).
     attr_accessor :updated
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -43,6 +57,7 @@ module KlaviyoAPI
         :'external_id' => :'external_id',
         :'title' => :'title',
         :'description' => :'description',
+        :'price' => :'price',
         :'url' => :'url',
         :'image_full_url' => :'image_full_url',
         :'image_thumbnail_url' => :'image_thumbnail_url',
@@ -65,6 +80,7 @@ module KlaviyoAPI
         :'external_id' => :'String',
         :'title' => :'String',
         :'description' => :'String',
+        :'price' => :'Float',
         :'url' => :'String',
         :'image_full_url' => :'String',
         :'image_thumbnail_url' => :'String',
@@ -109,6 +125,10 @@ module KlaviyoAPI
         self.description = attributes[:'description']
       end
 
+      if attributes.key?(:'price')
+        self.price = attributes[:'price']
+      end
+
       if attributes.key?(:'url')
         self.url = attributes[:'url']
       end
@@ -165,6 +185,7 @@ module KlaviyoAPI
           external_id == o.external_id &&
           title == o.title &&
           description == o.description &&
+          price == o.price &&
           url == o.url &&
           image_full_url == o.image_full_url &&
           image_thumbnail_url == o.image_thumbnail_url &&
@@ -184,7 +205,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [external_id, title, description, url, image_full_url, image_thumbnail_url, images, custom_metadata, published, created, updated].hash
+      [external_id, title, description, price, url, image_full_url, image_thumbnail_url, images, custom_metadata, published, created, updated].hash
     end
 
     # Builds the object from hash

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -17,6 +17,7 @@ module KlaviyoAPI
   class IncludedLists
     attr_accessor :type
 
+    # Primary key that uniquely identifies this list. Generated by Klaviyo.
     attr_accessor :id
 
     attr_accessor :attributes

data/lib/klaviyo-api-sdk/models/included_lists_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: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,10 +15,13 @@ require 'time'
 
 module KlaviyoAPI
   class IncludedListsAttributes
+    # A helpful name to label the list
     attr_accessor :name
 
+    # Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)
     attr_accessor :created
 
+    # Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)
     attr_accessor :updated
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

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

data/lib/klaviyo-api-sdk/models/included_metrics_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: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -17,6 +17,7 @@ module KlaviyoAPI
   class IncludedProfiles
     attr_accessor :type
 
+    # Primary key that uniquely identifies this profile. Generated by Klaviyo.
     attr_accessor :id
 
     attr_accessor :attributes

data/lib/klaviyo-api-sdk/models/included_profiles_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: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,32 +15,44 @@ require 'time'
 
 module KlaviyoAPI
   class IncludedProfilesAttributes
+    # Individual's email address
     attr_accessor :email
 
+    # Individual's phone number in E.164 format
     attr_accessor :phone_number
 
+    # A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
     attr_accessor :external_id
 
     attr_accessor :anonymous_id
 
+    # Individual's first name
     attr_accessor :first_name
 
+    # Individual's last name
     attr_accessor :last_name
 
+    # Name of the company or organization within the company for whom the individual works
     attr_accessor :organization
 
+    # Individual's job title
     attr_accessor :title
 
+    # URL pointing to the location of a profile image
     attr_accessor :image
 
+    # Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)
     attr_accessor :created
 
+    # Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)
     attr_accessor :updated
 
+    # Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)
     attr_accessor :last_event_date
 
     attr_accessor :location
 
+    # An object containing key/value pairs for any custom properties assigned to this profile
     attr_accessor :properties
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -3,7 +3,7 @@
 
 #The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
 
-The version of the OpenAPI document: 2023-01-24
+The version of the OpenAPI document: 2023-02-22
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -65,7 +65,7 @@ module KlaviyoAPI
       {
         :'type' => :'String',
         :'id' => :'String',
-        :'attributes' => :'IncludedListsAttributes',
+        :'attributes' => :'IncludedSegmentsAttributes',
         :'links' => :'IncludedVariantsLinks'
       }
     end