klaviyo-api-sdk 4.0.0 → 4.1.0

data/lib/klaviyo-api-sdk/models/catalog_variant_create_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: 2023-07-15
+The version of the OpenAPI document: 2023-08-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -15,50 +15,50 @@ require 'time'
 
 module KlaviyoAPI
   class CatalogVariantCreateQueryResourceObjectAttributes
-    # The SKU of the catalog item variant.
-    attr_accessor :sku
+    # The ID of the catalog item variant in an external system.
+    attr_accessor :external_id
 
-    # A description of the catalog item variant.
-    attr_accessor :description
+    # The type of catalog. Currently only \"$default\" is supported.
+    attr_accessor :catalog_type
+
+    # The integration type. Currently only \"$custom\" is supported.
+    attr_accessor :integration_type
 
     # The title of the catalog item variant.
     attr_accessor :title
 
-    # URL pointing to the location of the catalog item variant on your website.
-    attr_accessor :url
-
-    # This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity. 
-    attr_accessor :inventory_policy
+    # A description of the catalog item variant.
+    attr_accessor :description
 
-    # This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).
-    attr_accessor :price
+    # The SKU of the catalog item variant.
+    attr_accessor :sku
 
-    # Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.
-    attr_accessor :custom_metadata
+    # This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.
+    attr_accessor :inventory_policy
 
     # The quantity of the catalog item variant currently in stock.
     attr_accessor :inventory_quantity
 
-    # The type of catalog. Currently only \"$default\" is supported.
-    attr_accessor :catalog_type
+    # This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).
+    attr_accessor :price
+
+    # URL pointing to the location of the catalog item variant on your website.
+    attr_accessor :url
 
     # URL pointing to the location of a full image of the catalog item variant.
     attr_accessor :image_full_url
 
-    # Boolean value indicating whether the catalog item variant is published.
-    attr_accessor :published
+    # URL pointing to the location of an image thumbnail of the catalog item variant.
+    attr_accessor :image_thumbnail_url
 
     # List of URLs pointing to the locations of images of the catalog item variant.
     attr_accessor :images
 
-    # URL pointing to the location of an image thumbnail of the catalog item variant.
-    attr_accessor :image_thumbnail_url
-
-    # The ID of the catalog item variant in an external system.
-    attr_accessor :external_id
+    # Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.
+    attr_accessor :custom_metadata
 
-    # The integration type. Currently only \"$custom\" is supported.
-    attr_accessor :integration_type
+    # Boolean value indicating whether the catalog item variant is published.
+    attr_accessor :published
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -85,21 +85,21 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'sku' => :'sku',
-        :'description' => :'description',
+        :'external_id' => :'external_id',
+        :'catalog_type' => :'catalog_type',
+        :'integration_type' => :'integration_type',
         :'title' => :'title',
-        :'url' => :'url',
+        :'description' => :'description',
+        :'sku' => :'sku',
         :'inventory_policy' => :'inventory_policy',
-        :'price' => :'price',
-        :'custom_metadata' => :'custom_metadata',
         :'inventory_quantity' => :'inventory_quantity',
-        :'catalog_type' => :'catalog_type',
+        :'price' => :'price',
+        :'url' => :'url',
         :'image_full_url' => :'image_full_url',
-        :'published' => :'published',
-        :'images' => :'images',
         :'image_thumbnail_url' => :'image_thumbnail_url',
-        :'external_id' => :'external_id',
-        :'integration_type' => :'integration_type'
+        :'images' => :'images',
+        :'custom_metadata' => :'custom_metadata',
+        :'published' => :'published'
       }
     end
 
@@ -111,21 +111,21 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'sku' => :'String',
-        :'description' => :'String',
+        :'external_id' => :'String',
+        :'catalog_type' => :'String',
+        :'integration_type' => :'String',
         :'title' => :'String',
-        :'url' => :'String',
+        :'description' => :'String',
+        :'sku' => :'String',
         :'inventory_policy' => :'Integer',
-        :'price' => :'Float',
-        :'custom_metadata' => :'Object',
         :'inventory_quantity' => :'Float',
-        :'catalog_type' => :'String',
+        :'price' => :'Float',
+        :'url' => :'String',
         :'image_full_url' => :'String',
-        :'published' => :'Boolean',
-        :'images' => :'Array<String>',
         :'image_thumbnail_url' => :'String',
-        :'external_id' => :'String',
-        :'integration_type' => :'String'
+        :'images' => :'Array<String>',
+        :'custom_metadata' => :'Object',
+        :'published' => :'Boolean'
       }
     end
 
@@ -150,52 +150,56 @@ module KlaviyoAPI
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'sku')
-        self.sku = attributes[:'sku']
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
       end
 
-      if attributes.key?(:'description')
-        self.description = attributes[:'description']
+      if attributes.key?(:'catalog_type')
+        self.catalog_type = attributes[:'catalog_type']
+      else
+        self.catalog_type = '$default'
       end
 
-      if attributes.key?(:'title')
-        self.title = attributes[:'title']
+      if attributes.key?(:'integration_type')
+        self.integration_type = attributes[:'integration_type']
+      else
+        self.integration_type = '$custom'
       end
 
-      if attributes.key?(:'url')
-        self.url = attributes[:'url']
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
       end
 
-      if attributes.key?(:'inventory_policy')
-        self.inventory_policy = attributes[:'inventory_policy']
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
       end
 
-      if attributes.key?(:'price')
-        self.price = attributes[:'price']
+      if attributes.key?(:'sku')
+        self.sku = attributes[:'sku']
       end
 
-      if attributes.key?(:'custom_metadata')
-        self.custom_metadata = attributes[:'custom_metadata']
+      if attributes.key?(:'inventory_policy')
+        self.inventory_policy = attributes[:'inventory_policy']
       end
 
       if attributes.key?(:'inventory_quantity')
         self.inventory_quantity = attributes[:'inventory_quantity']
       end
 
-      if attributes.key?(:'catalog_type')
-        self.catalog_type = attributes[:'catalog_type']
-      else
-        self.catalog_type = '$default'
+      if attributes.key?(:'price')
+        self.price = attributes[:'price']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
       end
 
       if attributes.key?(:'image_full_url')
         self.image_full_url = attributes[:'image_full_url']
       end
 
-      if attributes.key?(:'published')
-        self.published = attributes[:'published']
-      else
-        self.published = true
+      if attributes.key?(:'image_thumbnail_url')
+        self.image_thumbnail_url = attributes[:'image_thumbnail_url']
       end
 
       if attributes.key?(:'images')
@@ -204,18 +208,14 @@ module KlaviyoAPI
         end
       end
 
-      if attributes.key?(:'image_thumbnail_url')
-        self.image_thumbnail_url = attributes[:'image_thumbnail_url']
-      end
-
-      if attributes.key?(:'external_id')
-        self.external_id = attributes[:'external_id']
+      if attributes.key?(:'custom_metadata')
+        self.custom_metadata = attributes[:'custom_metadata']
       end
 
-      if attributes.key?(:'integration_type')
-        self.integration_type = attributes[:'integration_type']
+      if attributes.key?(:'published')
+        self.published = attributes[:'published']
       else
-        self.integration_type = '$custom'
+        self.published = true
       end
     end
 
@@ -223,32 +223,32 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @sku.nil?
-        invalid_properties.push('invalid value for "sku", sku cannot be nil.')
-      end
-
-      if @description.nil?
-        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      if @external_id.nil?
+        invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
       end
 
       if @title.nil?
         invalid_properties.push('invalid value for "title", title cannot be nil.')
       end
 
-      if @url.nil?
-        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
       end
 
-      if @price.nil?
-        invalid_properties.push('invalid value for "price", price cannot be nil.')
+      if @sku.nil?
+        invalid_properties.push('invalid value for "sku", sku cannot be nil.')
       end
 
       if @inventory_quantity.nil?
         invalid_properties.push('invalid value for "inventory_quantity", inventory_quantity cannot be nil.')
       end
 
-      if @external_id.nil?
-        invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
+      if @price.nil?
+        invalid_properties.push('invalid value for "price", price cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
       end
 
       invalid_properties
@@ -257,30 +257,20 @@ 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 @sku.nil?
-      return false if @description.nil?
+      return false if @external_id.nil?
+      integration_type_validator = EnumAttributeValidator.new('String', ["$custom"])
+      return false unless integration_type_validator.valid?(@integration_type)
       return false if @title.nil?
-      return false if @url.nil?
+      return false if @description.nil?
+      return false if @sku.nil?
       inventory_policy_validator = EnumAttributeValidator.new('Integer', [0, 1, 2])
       return false unless inventory_policy_validator.valid?(@inventory_policy)
-      return false if @price.nil?
       return false if @inventory_quantity.nil?
-      return false if @external_id.nil?
-      integration_type_validator = EnumAttributeValidator.new('String', ["$custom"])
-      return false unless integration_type_validator.valid?(@integration_type)
+      return false if @price.nil?
+      return false if @url.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] inventory_policy Object to be assigned
-    def inventory_policy=(inventory_policy)
-      validator = EnumAttributeValidator.new('Integer', [0, 1, 2])
-      unless validator.valid?(inventory_policy)
-        fail ArgumentError, "invalid value for \"inventory_policy\", must be one of #{validator.allowable_values}."
-      end
-      @inventory_policy = inventory_policy
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] integration_type Object to be assigned
     def integration_type=(integration_type)
@@ -291,26 +281,36 @@ module KlaviyoAPI
       @integration_type = integration_type
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] inventory_policy Object to be assigned
+    def inventory_policy=(inventory_policy)
+      validator = EnumAttributeValidator.new('Integer', [0, 1, 2])
+      unless validator.valid?(inventory_policy)
+        fail ArgumentError, "invalid value for \"inventory_policy\", must be one of #{validator.allowable_values}."
+      end
+      @inventory_policy = inventory_policy
+    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 &&
-          sku == o.sku &&
-          description == o.description &&
+          external_id == o.external_id &&
+          catalog_type == o.catalog_type &&
+          integration_type == o.integration_type &&
           title == o.title &&
-          url == o.url &&
+          description == o.description &&
+          sku == o.sku &&
           inventory_policy == o.inventory_policy &&
-          price == o.price &&
-          custom_metadata == o.custom_metadata &&
           inventory_quantity == o.inventory_quantity &&
-          catalog_type == o.catalog_type &&
+          price == o.price &&
+          url == o.url &&
           image_full_url == o.image_full_url &&
-          published == o.published &&
-          images == o.images &&
           image_thumbnail_url == o.image_thumbnail_url &&
-          external_id == o.external_id &&
-          integration_type == o.integration_type
+          images == o.images &&
+          custom_metadata == o.custom_metadata &&
+          published == o.published
     end
 
     # @see the `==` method
@@ -322,7 +322,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sku, description, title, url, inventory_policy, price, custom_metadata, inventory_quantity, catalog_type, image_full_url, published, images, image_thumbnail_url, external_id, integration_type].hash
+      [external_id, catalog_type, integration_type, title, description, sku, inventory_policy, inventory_quantity, price, url, image_full_url, image_thumbnail_url, images, custom_metadata, published].hash
     end
 
     # Builds the object from hash

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

data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_resource_object_relationships_item.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-07-15
+The version of the OpenAPI document: 2023-08-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1
@@ -32,7 +32,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'CatalogCategoryUpdateQueryResourceObjectRelationshipsItemsDataInner'
+        :'data' => :'CatalogVariantCreateQueryResourceObjectRelationshipsItemData'
       }
     end
 

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

@@ -0,0 +1,238 @@
+=begin
+#Klaviyo API
+
+#The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.
+
+The version of the OpenAPI document: 2023-08-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 CatalogVariantCreateQueryResourceObjectRelationshipsItemData
+    attr_accessor :type
+
+    attr_accessor :id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'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
+      {
+        :'type' => :'CatalogItemEnum',
+        :'id' => :'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::CatalogVariantCreateQueryResourceObjectRelationshipsItemData` 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::CatalogVariantCreateQueryResourceObjectRelationshipsItemData`. 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?(:'type')
+        self.type = attributes[:'type']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id 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 @type.nil?
+      return false if @id.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 &&
+          type == o.type &&
+          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
+      [type, 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/catalog_variant_delete_job_create_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: 2023-07-15
+The version of the OpenAPI document: 2023-08-15
 Contact: developers@klaviyo.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.2.1