klaviyo-api-sdk 17.0.0 → 19.0.0

data/lib/klaviyo-api-sdk/models/{throttled_send_strategy.rb → inline_message_schedule.rb}

@@ -13,14 +13,22 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class ThrottledSendStrategy
-    attr_accessor :method
+  class InlineMessageSchedule
+    # The datetime at which the message should be sent (must be in the future). Required when strategy is not 'smart_send_time'.
+    attr_accessor :send_time
 
-    # The time to send at
-    attr_accessor :datetime
+    # The date on which the message should be sent. Required when strategy is 'smart_send_time'. Must not be in the past.
+    attr_accessor :send_date
 
-    # The percentage of recipients per hour to send to.
-    attr_accessor :throttle_percentage
+    # The send strategy to use: static, local_timezone, throttled, or smart_send_time
+    attr_accessor :strategy
+
+    attr_accessor :throttled_options
+
+    attr_accessor :timezone_options
+
+    # The campaign message ID to schedule
+    attr_accessor :message_id
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -47,9 +55,12 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'method' => :'method',
-        :'datetime' => :'datetime',
-        :'throttle_percentage' => :'throttle_percentage'
+        :'send_time' => :'send_time',
+        :'send_date' => :'send_date',
+        :'strategy' => :'strategy',
+        :'throttled_options' => :'throttled_options',
+        :'timezone_options' => :'timezone_options',
+        :'message_id' => :'message_id'
       }
     end
 
@@ -61,15 +72,20 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'method' => :'String',
-        :'datetime' => :'Time',
-        :'throttle_percentage' => :'Integer'
+        :'send_time' => :'Time',
+        :'send_date' => :'Date',
+        :'strategy' => :'String',
+        :'throttled_options' => :'ThrottledOptions',
+        :'timezone_options' => :'TimezoneOptions',
+        :'message_id' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'send_time',
+        :'send_date',
       ])
     end
 
@@ -77,27 +93,39 @@ 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::ThrottledSendStrategy` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::InlineMessageSchedule` 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::ThrottledSendStrategy`. 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::InlineMessageSchedule`. 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?(:'method')
-        self.method = attributes[:'method']
+      if attributes.key?(:'send_time')
+        self.send_time = attributes[:'send_time']
+      end
+
+      if attributes.key?(:'send_date')
+        self.send_date = attributes[:'send_date']
+      end
+
+      if attributes.key?(:'strategy')
+        self.strategy = attributes[:'strategy']
       end
 
-      if attributes.key?(:'datetime')
-        self.datetime = attributes[:'datetime']
+      if attributes.key?(:'throttled_options')
+        self.throttled_options = attributes[:'throttled_options']
       end
 
-      if attributes.key?(:'throttle_percentage')
-        self.throttle_percentage = attributes[:'throttle_percentage']
+      if attributes.key?(:'timezone_options')
+        self.timezone_options = attributes[:'timezone_options']
+      end
+
+      if attributes.key?(:'message_id')
+        self.message_id = attributes[:'message_id']
       end
     end
 
@@ -105,16 +133,12 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @method.nil?
-        invalid_properties.push('invalid value for "method", method cannot be nil.')
-      end
-
-      if @datetime.nil?
-        invalid_properties.push('invalid value for "datetime", datetime cannot be nil.')
+      if @strategy.nil?
+        invalid_properties.push('invalid value for "strategy", strategy cannot be nil.')
       end
 
-      if @throttle_percentage.nil?
-        invalid_properties.push('invalid value for "throttle_percentage", throttle_percentage cannot be nil.')
+      if @message_id.nil?
+        invalid_properties.push('invalid value for "message_id", message_id cannot be nil.')
       end
 
       invalid_properties
@@ -123,34 +147,21 @@ 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 @method.nil?
-      method_validator = EnumAttributeValidator.new('String', ["throttled"])
-      return false unless method_validator.valid?(@method)
-      return false if @datetime.nil?
-      return false if @throttle_percentage.nil?
-      throttle_percentage_validator = EnumAttributeValidator.new('Integer', [10, 11, 13, 14, 17, 20, 25, 33, 50])
-      return false unless throttle_percentage_validator.valid?(@throttle_percentage)
+      return false if @strategy.nil?
+      strategy_validator = EnumAttributeValidator.new('String', ["local_timezone", "smart_send_time", "static", "throttled"])
+      return false unless strategy_validator.valid?(@strategy)
+      return false if @message_id.nil?
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] method Object to be assigned
-    def method=(method)
-      validator = EnumAttributeValidator.new('String', ["throttled"])
-      unless validator.valid?(method)
-        fail ArgumentError, "invalid value for \"method\", must be one of #{validator.allowable_values}."
-      end
-      @method = method
-    end
-
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] throttle_percentage Object to be assigned
-    def throttle_percentage=(throttle_percentage)
-      validator = EnumAttributeValidator.new('Integer', [10, 11, 13, 14, 17, 20, 25, 33, 50])
-      unless validator.valid?(throttle_percentage)
-        fail ArgumentError, "invalid value for \"throttle_percentage\", must be one of #{validator.allowable_values}."
+    # @param [Object] strategy Object to be assigned
+    def strategy=(strategy)
+      validator = EnumAttributeValidator.new('String', ["local_timezone", "smart_send_time", "static", "throttled"])
+      unless validator.valid?(strategy)
+        fail ArgumentError, "invalid value for \"strategy\", must be one of #{validator.allowable_values}."
       end
-      @throttle_percentage = throttle_percentage
+      @strategy = strategy
     end
 
     # Checks equality by comparing each attribute.
@@ -158,9 +169,12 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          method == o.method &&
-          datetime == o.datetime &&
-          throttle_percentage == o.throttle_percentage
+          send_time == o.send_time &&
+          send_date == o.send_date &&
+          strategy == o.strategy &&
+          throttled_options == o.throttled_options &&
+          timezone_options == o.timezone_options &&
+          message_id == o.message_id
     end
 
     # @see the `==` method
@@ -172,7 +186,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [method, datetime, throttle_percentage].hash
+      [send_time, send_date, strategy, throttled_options, timezone_options, message_id].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,307 @@
+=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 InputStyleOverrides
+    attr_accessor :enabled
+
+    attr_accessor :input_text_styles
+
+    attr_accessor :label_text_styles
+
+    attr_accessor :placeholder_text_styles
+
+    attr_accessor :background_color
+
+    attr_accessor :border_color
+
+    attr_accessor :border_focus_color
+
+    attr_accessor :focus_outline_color
+
+    attr_accessor :corner_radius
+
+    attr_accessor :field_height
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'enabled' => :'enabled',
+        :'input_text_styles' => :'input_text_styles',
+        :'label_text_styles' => :'label_text_styles',
+        :'placeholder_text_styles' => :'placeholder_text_styles',
+        :'background_color' => :'background_color',
+        :'border_color' => :'border_color',
+        :'border_focus_color' => :'border_focus_color',
+        :'focus_outline_color' => :'focus_outline_color',
+        :'corner_radius' => :'corner_radius',
+        :'field_height' => :'field_height'
+      }
+    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
+      {
+        :'enabled' => :'Boolean',
+        :'input_text_styles' => :'TextStyleOverrides',
+        :'label_text_styles' => :'TextStyleOverrides',
+        :'placeholder_text_styles' => :'TextStyleOverrides',
+        :'background_color' => :'String',
+        :'border_color' => :'String',
+        :'border_focus_color' => :'String',
+        :'focus_outline_color' => :'String',
+        :'corner_radius' => :'Integer',
+        :'field_height' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'background_color',
+        :'border_color',
+        :'border_focus_color',
+        :'focus_outline_color',
+        :'corner_radius',
+        :'field_height'
+      ])
+    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::InputStyleOverrides` 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::InputStyleOverrides`. 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?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = false
+      end
+
+      if attributes.key?(:'input_text_styles')
+        self.input_text_styles = attributes[:'input_text_styles']
+      end
+
+      if attributes.key?(:'label_text_styles')
+        self.label_text_styles = attributes[:'label_text_styles']
+      end
+
+      if attributes.key?(:'placeholder_text_styles')
+        self.placeholder_text_styles = attributes[:'placeholder_text_styles']
+      end
+
+      if attributes.key?(:'background_color')
+        self.background_color = attributes[:'background_color']
+      end
+
+      if attributes.key?(:'border_color')
+        self.border_color = attributes[:'border_color']
+      end
+
+      if attributes.key?(:'border_focus_color')
+        self.border_focus_color = attributes[:'border_focus_color']
+      end
+
+      if attributes.key?(:'focus_outline_color')
+        self.focus_outline_color = attributes[:'focus_outline_color']
+      end
+
+      if attributes.key?(:'corner_radius')
+        self.corner_radius = attributes[:'corner_radius']
+      end
+
+      if attributes.key?(:'field_height')
+        self.field_height = attributes[:'field_height']
+      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 &&
+          enabled == o.enabled &&
+          input_text_styles == o.input_text_styles &&
+          label_text_styles == o.label_text_styles &&
+          placeholder_text_styles == o.placeholder_text_styles &&
+          background_color == o.background_color &&
+          border_color == o.border_color &&
+          border_focus_color == o.border_focus_color &&
+          focus_outline_color == o.focus_outline_color &&
+          corner_radius == o.corner_radius &&
+          field_height == o.field_height
+    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
+      [enabled, input_text_styles, label_text_styles, placeholder_text_styles, background_color, border_color, border_focus_color, focus_outline_color, corner_radius, field_height].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