klaviyo-api-sdk 14.0.1 → 16.0.0

data/lib/klaviyo-api-sdk/models/{profile_partial_update_query_resource_object_attributes.rb → go_to_inbox.rb}

@@ -13,55 +13,43 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class ProfilePartialUpdateQueryResourceObjectAttributes
-    # Individual's email address
-    attr_accessor :email
+  class GoToInbox
+    attr_accessor :id
 
-    # Individual's phone number in E.164 format
-    attr_accessor :phone_number
+    attr_accessor :submit
 
-    # 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 :type
 
-    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
-
-    # The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)
-    attr_accessor :locale
-
-    # Individual's job title
-    attr_accessor :title
-
-    # URL pointing to the location of a profile image
-    attr_accessor :image
+    attr_accessor :properties
 
-    attr_accessor :location
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
 
-    # An object containing key/value pairs for any custom properties assigned to this profile
-    attr_accessor :properties
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'email' => :'email',
-        :'phone_number' => :'phone_number',
-        :'external_id' => :'external_id',
-        :'anonymous_id' => :'anonymous_id',
-        :'first_name' => :'first_name',
-        :'last_name' => :'last_name',
-        :'organization' => :'organization',
-        :'locale' => :'locale',
-        :'title' => :'title',
-        :'image' => :'image',
-        :'location' => :'location',
+        :'id' => :'id',
+        :'submit' => :'submit',
+        :'type' => :'type',
         :'properties' => :'properties'
       }
     end
@@ -74,35 +62,17 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'email' => :'String',
-        :'phone_number' => :'String',
-        :'external_id' => :'String',
-        :'anonymous_id' => :'String',
-        :'first_name' => :'String',
-        :'last_name' => :'String',
-        :'organization' => :'String',
-        :'locale' => :'String',
-        :'title' => :'String',
-        :'image' => :'String',
-        :'location' => :'ProfileLocation',
-        :'properties' => :'Object'
+        :'id' => :'String',
+        :'submit' => :'Boolean',
+        :'type' => :'GoToInboxEnum',
+        :'properties' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'email',
-        :'phone_number',
-        :'external_id',
-        :'anonymous_id',
-        :'first_name',
-        :'last_name',
-        :'organization',
-        :'locale',
-        :'title',
-        :'image',
-        :'properties'
+        :'id',
       ])
     end
 
@@ -110,59 +80,29 @@ 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::ProfilePartialUpdateQueryResourceObjectAttributes` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::GoToInbox` 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::ProfilePartialUpdateQueryResourceObjectAttributes`. 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::GoToInbox`. 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?(:'email')
-        self.email = attributes[:'email']
-      end
-
-      if attributes.key?(:'phone_number')
-        self.phone_number = attributes[:'phone_number']
-      end
-
-      if attributes.key?(:'external_id')
-        self.external_id = attributes[:'external_id']
-      end
-
-      if attributes.key?(:'anonymous_id')
-        self.anonymous_id = attributes[:'anonymous_id']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'first_name')
-        self.first_name = attributes[:'first_name']
-      end
-
-      if attributes.key?(:'last_name')
-        self.last_name = attributes[:'last_name']
-      end
-
-      if attributes.key?(:'organization')
-        self.organization = attributes[:'organization']
-      end
-
-      if attributes.key?(:'locale')
-        self.locale = attributes[:'locale']
-      end
-
-      if attributes.key?(:'title')
-        self.title = attributes[:'title']
-      end
-
-      if attributes.key?(:'image')
-        self.image = attributes[:'image']
+      if attributes.key?(:'submit')
+        self.submit = attributes[:'submit']
+      else
+        self.submit = true
       end
 
-      if attributes.key?(:'location')
-        self.location = attributes[:'location']
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
       end
 
       if attributes.key?(:'properties')
@@ -174,31 +114,52 @@ module KlaviyoAPI
     # @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
+
       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?
+      submit_validator = EnumAttributeValidator.new('Boolean', ["true"])
+      return false unless submit_validator.valid?(@submit)
+      return false if @type.nil?
+      properties_validator = EnumAttributeValidator.new('String', ["null"])
+      return false unless properties_validator.valid?(@properties)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] submit Object to be assigned
+    def submit=(submit)
+      validator = EnumAttributeValidator.new('Boolean', ["true"])
+      unless validator.valid?(submit)
+        fail ArgumentError, "invalid value for \"submit\", must be one of #{validator.allowable_values}."
+      end
+      @submit = submit
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] properties Object to be assigned
+    def properties=(properties)
+      validator = EnumAttributeValidator.new('String', ["null"])
+      unless validator.valid?(properties)
+        fail ArgumentError, "invalid value for \"properties\", must be one of #{validator.allowable_values}."
+      end
+      @properties = properties
+    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 &&
-          email == o.email &&
-          phone_number == o.phone_number &&
-          external_id == o.external_id &&
-          anonymous_id == o.anonymous_id &&
-          first_name == o.first_name &&
-          last_name == o.last_name &&
-          organization == o.organization &&
-          locale == o.locale &&
-          title == o.title &&
-          image == o.image &&
-          location == o.location &&
+          id == o.id &&
+          submit == o.submit &&
+          type == o.type &&
           properties == o.properties
     end
 
@@ -211,7 +172,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, phone_number, external_id, anonymous_id, first_name, last_name, organization, locale, title, image, location, properties].hash
+      [id, submit, type, properties].hash
     end
 
     # Builds the object from hash

data/lib/klaviyo-api-sdk/models/go_to_inbox_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 GoToInboxEnum
+    GO_TO_INBOX = "go_to_inbox".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 = GoToInboxEnum.constants.select { |c| GoToInboxEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #GoToInboxEnum" if constantValues.empty?
+      value
+    end
+  end
+end

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

@@ -0,0 +1,251 @@
+=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 HTMLText
+    attr_accessor :id
+
+    attr_accessor :type
+
+    attr_accessor :styles
+
+    attr_accessor :properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'type' => :'type',
+        :'styles' => :'styles',
+        :'properties' => :'properties'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'type' => :'HtmlTextEnum',
+        :'styles' => :'HTMLTextStyles',
+        :'properties' => :'HTMLTextProperties'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::HTMLText` 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::HTMLText`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'styles')
+        self.styles = attributes[:'styles']
+      end
+
+      if attributes.key?(:'properties')
+        self.properties = attributes[:'properties']
+      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
+
+      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?
+      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 &&
+          id == o.id &&
+          type == o.type &&
+          styles == o.styles &&
+          properties == o.properties
+    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
+      [id, type, styles, properties].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/html_text_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 HtmlTextEnum
+    HTML_TEXT = "html_text".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 = HtmlTextEnum.constants.select { |c| HtmlTextEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #HtmlTextEnum" if constantValues.empty?
+      value
+    end
+  end
+end