ultracart_api 4.1.207 → 4.1.209

data/lib/ultracart_api/models/item_third_party_email_marketing.rb

@@ -139,7 +139,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      provider_name_validator = EnumAttributeValidator.new('String', ["ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "Lyris", "LyrisHQ", "MailChimp"])
+      provider_name_validator = EnumAttributeValidator.new('String', ["ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "MailChimp"])
       return false unless provider_name_validator.valid?(@provider_name)
       true
     end
@@ -147,7 +147,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] provider_name Object to be assigned
     def provider_name=(provider_name)
-      validator = EnumAttributeValidator.new('String', ["ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "Lyris", "LyrisHQ", "MailChimp"])
+      validator = EnumAttributeValidator.new('String', ["ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "MailChimp"])
       unless validator.valid?(provider_name)
         fail ArgumentError, "invalid value for \"provider_name\", must be one of #{validator.allowable_values}."
       end

data/lib/ultracart_api/models/sfvb_archive_request.rb

@@ -0,0 +1,220 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class SfvbArchiveRequest
+    # True to archive, false to unarchive.
+    attr_accessor :archived
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'archived' => :'archived'
+      }
+    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
+      {
+        :'archived' => :'Boolean'
+      }
+    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 `UltracartClient::SfvbArchiveRequest` 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 `UltracartClient::SfvbArchiveRequest`. 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?(:'archived')
+        self.archived = attributes[:'archived']
+      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 &&
+          archived == o.archived
+    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
+      [archived].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 = UltracartClient.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/ultracart_api/models/sfvb_campaign.rb

@@ -30,18 +30,42 @@ module UltracartClient
     # Its emails, in step order.
     attr_accessor :emails
 
+    # True when a customer leaves the campaign once they buy from one of its emails.
+    attr_accessor :end_once_customer_purchases
+
+    # True when a customer leaves the campaign once they buy from any source.
+    attr_accessor :end_once_customer_purchases_anywhere
+
+    # Send this as If-Match when changing or archiving the campaign.
+    attr_accessor :hash_sha256
+
     # True when the emails and postcards reach customers now, so a change to one shows at once.  False only in a status that sends nothing.
     attr_accessor :live
 
+    # The lists and segments it sends to or leaves out.
+    attr_accessor :memberships
+
     # The campaign name.
     attr_accessor :name
 
+    # What a write did beyond the fields it was asked to change, such as putting emails back to needing review or setting a scheduled campaign back to draft.  Only on a write.
+    attr_accessor :notes
+
     # Its postcards, in step order.
     attr_accessor :postcards
 
     # When the campaign is scheduled to send (ISO 8601, UTC), when it is.
     attr_accessor :scheduled_dts
 
+    # The sending domain uuid.  Defaults to the storefront's marketing sending domain.
+    attr_accessor :sending_domain_uuid
+
+    # The from name.  Defaults to the storefront's marketing setting.
+    attr_accessor :sending_name
+
+    # The part of the from address before the at sign.  Defaults to the storefront's marketing setting.
+    attr_accessor :sending_user
+
     # The status, such as draft, scheduled, sending, sent or archived.
     attr_accessor :status
 
@@ -56,10 +80,18 @@ module UltracartClient
         :'created_dts' => :'created_dts',
         :'deleted' => :'deleted',
         :'emails' => :'emails',
+        :'end_once_customer_purchases' => :'end_once_customer_purchases',
+        :'end_once_customer_purchases_anywhere' => :'end_once_customer_purchases_anywhere',
+        :'hash_sha256' => :'hash_sha256',
         :'live' => :'live',
+        :'memberships' => :'memberships',
         :'name' => :'name',
+        :'notes' => :'notes',
         :'postcards' => :'postcards',
         :'scheduled_dts' => :'scheduled_dts',
+        :'sending_domain_uuid' => :'sending_domain_uuid',
+        :'sending_name' => :'sending_name',
+        :'sending_user' => :'sending_user',
         :'status' => :'status',
         :'status_dts' => :'status_dts'
       }
@@ -78,10 +110,18 @@ module UltracartClient
         :'created_dts' => :'String',
         :'deleted' => :'Boolean',
         :'emails' => :'Array<SfvbCommsEmail>',
+        :'end_once_customer_purchases' => :'Boolean',
+        :'end_once_customer_purchases_anywhere' => :'Boolean',
+        :'hash_sha256' => :'String',
         :'live' => :'Boolean',
+        :'memberships' => :'Array<SfvbCampaignMembership>',
         :'name' => :'String',
+        :'notes' => :'Array<String>',
         :'postcards' => :'Array<SfvbCommsPostcard>',
         :'scheduled_dts' => :'String',
+        :'sending_domain_uuid' => :'String',
+        :'sending_name' => :'String',
+        :'sending_user' => :'String',
         :'status' => :'String',
         :'status_dts' => :'String'
       }
@@ -130,14 +170,38 @@ module UltracartClient
         end
       end
 
+      if attributes.key?(:'end_once_customer_purchases')
+        self.end_once_customer_purchases = attributes[:'end_once_customer_purchases']
+      end
+
+      if attributes.key?(:'end_once_customer_purchases_anywhere')
+        self.end_once_customer_purchases_anywhere = attributes[:'end_once_customer_purchases_anywhere']
+      end
+
+      if attributes.key?(:'hash_sha256')
+        self.hash_sha256 = attributes[:'hash_sha256']
+      end
+
       if attributes.key?(:'live')
         self.live = attributes[:'live']
       end
 
+      if attributes.key?(:'memberships')
+        if (value = attributes[:'memberships']).is_a?(Array)
+          self.memberships = value
+        end
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
 
+      if attributes.key?(:'notes')
+        if (value = attributes[:'notes']).is_a?(Array)
+          self.notes = value
+        end
+      end
+
       if attributes.key?(:'postcards')
         if (value = attributes[:'postcards']).is_a?(Array)
           self.postcards = value
@@ -148,6 +212,18 @@ module UltracartClient
         self.scheduled_dts = attributes[:'scheduled_dts']
       end
 
+      if attributes.key?(:'sending_domain_uuid')
+        self.sending_domain_uuid = attributes[:'sending_domain_uuid']
+      end
+
+      if attributes.key?(:'sending_name')
+        self.sending_name = attributes[:'sending_name']
+      end
+
+      if attributes.key?(:'sending_user')
+        self.sending_user = attributes[:'sending_user']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -180,10 +256,18 @@ module UltracartClient
           created_dts == o.created_dts &&
           deleted == o.deleted &&
           emails == o.emails &&
+          end_once_customer_purchases == o.end_once_customer_purchases &&
+          end_once_customer_purchases_anywhere == o.end_once_customer_purchases_anywhere &&
+          hash_sha256 == o.hash_sha256 &&
           live == o.live &&
+          memberships == o.memberships &&
           name == o.name &&
+          notes == o.notes &&
           postcards == o.postcards &&
           scheduled_dts == o.scheduled_dts &&
+          sending_domain_uuid == o.sending_domain_uuid &&
+          sending_name == o.sending_name &&
+          sending_user == o.sending_user &&
           status == o.status &&
           status_dts == o.status_dts
     end
@@ -197,7 +281,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [campaign_uuid, communication_sequence_uuid, created_dts, deleted, emails, live, name, postcards, scheduled_dts, status, status_dts].hash
+      [campaign_uuid, communication_sequence_uuid, created_dts, deleted, emails, end_once_customer_purchases, end_once_customer_purchases_anywhere, hash_sha256, live, memberships, name, notes, postcards, scheduled_dts, sending_domain_uuid, sending_name, sending_user, status, status_dts].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_campaign_membership.rb

@@ -0,0 +1,250 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class SfvbCampaignMembership
+    # True to leave its members out instead of sending to them.
+    attr_accessor :exclude
+
+    # The list uuid, for a list.
+    attr_accessor :list_uuid
+
+    # The list or segment name.  Set by the server.
+    attr_accessor :name
+
+    # The segment uuid, for a segment.
+    attr_accessor :segment_uuid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'exclude' => :'exclude',
+        :'list_uuid' => :'list_uuid',
+        :'name' => :'name',
+        :'segment_uuid' => :'segment_uuid'
+      }
+    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
+      {
+        :'exclude' => :'Boolean',
+        :'list_uuid' => :'String',
+        :'name' => :'String',
+        :'segment_uuid' => :'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 `UltracartClient::SfvbCampaignMembership` 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 `UltracartClient::SfvbCampaignMembership`. 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?(:'exclude')
+        self.exclude = attributes[:'exclude']
+      end
+
+      if attributes.key?(:'list_uuid')
+        self.list_uuid = attributes[:'list_uuid']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'segment_uuid')
+        self.segment_uuid = attributes[:'segment_uuid']
+      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 &&
+          exclude == o.exclude &&
+          list_uuid == o.list_uuid &&
+          name == o.name &&
+          segment_uuid == o.segment_uuid
+    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
+      [exclude, list_uuid, name, segment_uuid].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 = UltracartClient.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