klaviyo-api-sdk 17.0.0 → 19.0.0

data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query_resource_object.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 CampaignMessageScheduleUpdateQueryResourceObject
+    attr_accessor :type
+
+    attr_accessor :id
+
+    attr_accessor :attributes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'id' => :'id',
+        :'attributes' => :'attributes'
+      }
+    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' => :'CampaignMessageScheduleEnum',
+        :'id' => :'String',
+        :'attributes' => :'CampaignMessageScheduleUpdateQueryResourceObjectAttributes'
+      }
+    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::CampaignMessageScheduleUpdateQueryResourceObject` 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::CampaignMessageScheduleUpdateQueryResourceObject`. 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
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      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
+
+      if @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes 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?
+      return false if @attributes.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 &&
+          attributes == o.attributes
+    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, attributes].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/{non_local_static_send.rb → campaign_message_schedule_update_query_resource_object_attributes.rb}

@@ -13,9 +13,9 @@ require 'date'
 require 'time'
 
 module KlaviyoAPI
-  class NonLocalStaticSend
-    # Whether the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time.
-    attr_accessor :is_local
+  class CampaignMessageScheduleUpdateQueryResourceObjectAttributes
+    # The action to take: 'cancel' or 'revert'
+    attr_accessor :action
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -42,7 +42,7 @@ module KlaviyoAPI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'is_local' => :'is_local'
+        :'action' => :'action'
       }
     end
 
@@ -54,7 +54,7 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'is_local' => :'Boolean'
+        :'action' => :'String'
       }
     end
 
@@ -68,19 +68,19 @@ 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::NonLocalStaticSend` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::CampaignMessageScheduleUpdateQueryResourceObjectAttributes` 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::NonLocalStaticSend`. 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::CampaignMessageScheduleUpdateQueryResourceObjectAttributes`. 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?(:'is_local')
-        self.is_local = attributes[:'is_local']
+      if attributes.key?(:'action')
+        self.action = attributes[:'action']
       end
     end
 
@@ -88,8 +88,8 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @is_local.nil?
-        invalid_properties.push('invalid value for "is_local", is_local cannot be nil.')
+      if @action.nil?
+        invalid_properties.push('invalid value for "action", action cannot be nil.')
       end
 
       invalid_properties
@@ -98,20 +98,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 @is_local.nil?
-      is_local_validator = EnumAttributeValidator.new('Boolean', ["false"])
-      return false unless is_local_validator.valid?(@is_local)
+      return false if @action.nil?
+      action_validator = EnumAttributeValidator.new('String', ["cancel", "revert"])
+      return false unless action_validator.valid?(@action)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] is_local Object to be assigned
-    def is_local=(is_local)
-      validator = EnumAttributeValidator.new('Boolean', ["false"])
-      unless validator.valid?(is_local)
-        fail ArgumentError, "invalid value for \"is_local\", must be one of #{validator.allowable_values}."
+    # @param [Object] action Object to be assigned
+    def action=(action)
+      validator = EnumAttributeValidator.new('String', ["cancel", "revert"])
+      unless validator.valid?(action)
+        fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
       end
-      @is_local = is_local
+      @action = action
     end
 
     # Checks equality by comparing each attribute.
@@ -119,7 +119,7 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          is_local == o.is_local
+          action == o.action
     end
 
     # @see the `==` method
@@ -131,7 +131,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [is_local].hash
+      [action].hash
     end
 
     # Builds the object from hash

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

@@ -16,7 +16,7 @@ module KlaviyoAPI
   class CampaignPartialUpdateQueryResourceObject
     attr_accessor :type
 
-    # The campaign ID to be retrieved
+    # The campaign ID to be updated
     attr_accessor :id
 
     attr_accessor :attributes

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

@@ -14,25 +14,12 @@ require 'time'
 
 module KlaviyoAPI
   class CampaignPartialUpdateQueryResourceObjectAttributes
-    # The campaign name
-    attr_accessor :name
-
-    attr_accessor :audiences
-
-    attr_accessor :send_options
-
-    attr_accessor :tracking_options
-
-    attr_accessor :send_strategy
+    attr_accessor :definition
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'name' => :'name',
-        :'audiences' => :'audiences',
-        :'send_options' => :'send_options',
-        :'tracking_options' => :'tracking_options',
-        :'send_strategy' => :'send_strategy'
+        :'definition' => :'definition'
       }
     end
 
@@ -44,21 +31,13 @@ module KlaviyoAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'name' => :'String',
-        :'audiences' => :'AudiencesUpdate',
-        :'send_options' => :'CampaignCreateQueryResourceObjectAttributesSendOptions',
-        :'tracking_options' => :'CampaignCreateQueryResourceObjectAttributesTrackingOptions',
-        :'send_strategy' => :'CampaignPartialUpdateQueryResourceObjectAttributesSendStrategy'
+        :'definition' => :'CampaignDefinition'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'name',
-        :'send_options',
-        :'tracking_options',
-        :'send_strategy'
       ])
     end
 
@@ -77,24 +56,8 @@ 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_options')
-        self.send_options = attributes[:'send_options']
-      end
-
-      if attributes.key?(:'tracking_options')
-        self.tracking_options = attributes[:'tracking_options']
-      end
-
-      if attributes.key?(:'send_strategy')
-        self.send_strategy = attributes[:'send_strategy']
+      if attributes.key?(:'definition')
+        self.definition = attributes[:'definition']
       end
     end
 
@@ -102,12 +65,17 @@ module KlaviyoAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @definition.nil?
+        invalid_properties.push('invalid value for "definition", definition 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 @definition.nil?
       true
     end
 
@@ -116,11 +84,7 @@ module KlaviyoAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          name == o.name &&
-          audiences == o.audiences &&
-          send_options == o.send_options &&
-          tracking_options == o.tracking_options &&
-          send_strategy == o.send_strategy
+          definition == o.definition
     end
 
     # @see the `==` method
@@ -132,7 +96,7 @@ module KlaviyoAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, audiences, send_options, tracking_options, send_strategy].hash
+      [definition].hash
     end
 
     # Builds the object from hash

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