ultracart_api 4.1.207 → 4.1.209

data/lib/ultracart_api/models/sfvb_flow.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module UltracartClient
   class SfvbFlow
+    # True when a customer may be in this flow more than once at a time.
+    attr_accessor :allow_multiple_concurrent_enrollments
+
     # The communication sequence the steps belong to.
     attr_accessor :communication_sequence_uuid
 
@@ -27,24 +30,54 @@ module UltracartClient
     # Its emails, in step order.
     attr_accessor :emails
 
+    # True when a customer leaves the flow once they buy from one of its emails.
+    attr_accessor :end_once_customer_purchases
+
+    # True when a customer leaves the flow once they buy from any source.
+    attr_accessor :end_once_customer_purchases_anywhere
+
     # The flow uuid.
     attr_accessor :flow_uuid
 
+    # Send this as If-Match when changing, archiving or turning the flow on or off.
+    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 flow 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
 
+    # Days before a customer may enter again, with after_days.
+    attr_accessor :reentry_delay_days
+
+    # Whether a customer may enter again, anytime, after_days or never.
+    attr_accessor :reentry_policy
+
+    # 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, active, paused, draining or inactive.
     attr_accessor :status
 
     # When the status last changed (ISO 8601, UTC).
     attr_accessor :status_dts
 
+    # The list or segment uuid, or other value, the trigger is limited to.
+    attr_accessor :trigger_parameter
+
     # The name of the trigger parameter, when the trigger takes one.
     attr_accessor :trigger_parameter_name
 
@@ -54,16 +87,27 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'allow_multiple_concurrent_enrollments' => :'allow_multiple_concurrent_enrollments',
         :'communication_sequence_uuid' => :'communication_sequence_uuid',
         :'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',
         :'flow_uuid' => :'flow_uuid',
+        :'hash_sha256' => :'hash_sha256',
         :'live' => :'live',
         :'name' => :'name',
+        :'notes' => :'notes',
         :'postcards' => :'postcards',
+        :'reentry_delay_days' => :'reentry_delay_days',
+        :'reentry_policy' => :'reentry_policy',
+        :'sending_domain_uuid' => :'sending_domain_uuid',
+        :'sending_name' => :'sending_name',
+        :'sending_user' => :'sending_user',
         :'status' => :'status',
         :'status_dts' => :'status_dts',
+        :'trigger_parameter' => :'trigger_parameter',
         :'trigger_parameter_name' => :'trigger_parameter_name',
         :'trigger_type' => :'trigger_type'
       }
@@ -77,16 +121,27 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'allow_multiple_concurrent_enrollments' => :'Boolean',
         :'communication_sequence_uuid' => :'String',
         :'created_dts' => :'String',
         :'deleted' => :'Boolean',
         :'emails' => :'Array<SfvbCommsEmail>',
+        :'end_once_customer_purchases' => :'Boolean',
+        :'end_once_customer_purchases_anywhere' => :'Boolean',
         :'flow_uuid' => :'String',
+        :'hash_sha256' => :'String',
         :'live' => :'Boolean',
         :'name' => :'String',
+        :'notes' => :'Array<String>',
         :'postcards' => :'Array<SfvbCommsPostcard>',
+        :'reentry_delay_days' => :'Integer',
+        :'reentry_policy' => :'String',
+        :'sending_domain_uuid' => :'String',
+        :'sending_name' => :'String',
+        :'sending_user' => :'String',
         :'status' => :'String',
         :'status_dts' => :'String',
+        :'trigger_parameter' => :'String',
         :'trigger_parameter_name' => :'String',
         :'trigger_type' => :'String'
       }
@@ -113,6 +168,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'allow_multiple_concurrent_enrollments')
+        self.allow_multiple_concurrent_enrollments = attributes[:'allow_multiple_concurrent_enrollments']
+      end
+
       if attributes.key?(:'communication_sequence_uuid')
         self.communication_sequence_uuid = attributes[:'communication_sequence_uuid']
       end
@@ -131,10 +190,22 @@ 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?(:'flow_uuid')
         self.flow_uuid = attributes[:'flow_uuid']
       end
 
+      if attributes.key?(:'hash_sha256')
+        self.hash_sha256 = attributes[:'hash_sha256']
+      end
+
       if attributes.key?(:'live')
         self.live = attributes[:'live']
       end
@@ -143,12 +214,38 @@ module UltracartClient
         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
         end
       end
 
+      if attributes.key?(:'reentry_delay_days')
+        self.reentry_delay_days = attributes[:'reentry_delay_days']
+      end
+
+      if attributes.key?(:'reentry_policy')
+        self.reentry_policy = attributes[:'reentry_policy']
+      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
@@ -157,6 +254,10 @@ module UltracartClient
         self.status_dts = attributes[:'status_dts']
       end
 
+      if attributes.key?(:'trigger_parameter')
+        self.trigger_parameter = attributes[:'trigger_parameter']
+      end
+
       if attributes.key?(:'trigger_parameter_name')
         self.trigger_parameter_name = attributes[:'trigger_parameter_name']
       end
@@ -184,16 +285,27 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          allow_multiple_concurrent_enrollments == o.allow_multiple_concurrent_enrollments &&
           communication_sequence_uuid == o.communication_sequence_uuid &&
           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 &&
           flow_uuid == o.flow_uuid &&
+          hash_sha256 == o.hash_sha256 &&
           live == o.live &&
           name == o.name &&
+          notes == o.notes &&
           postcards == o.postcards &&
+          reentry_delay_days == o.reentry_delay_days &&
+          reentry_policy == o.reentry_policy &&
+          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 &&
+          trigger_parameter == o.trigger_parameter &&
           trigger_parameter_name == o.trigger_parameter_name &&
           trigger_type == o.trigger_type
     end
@@ -207,7 +319,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [communication_sequence_uuid, created_dts, deleted, emails, flow_uuid, live, name, postcards, status, status_dts, trigger_parameter_name, trigger_type].hash
+      [allow_multiple_concurrent_enrollments, communication_sequence_uuid, created_dts, deleted, emails, end_once_customer_purchases, end_once_customer_purchases_anywhere, flow_uuid, hash_sha256, live, name, notes, postcards, reentry_delay_days, reentry_policy, sending_domain_uuid, sending_name, sending_user, status, status_dts, trigger_parameter, trigger_parameter_name, trigger_type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_flow_status_request.rb

@@ -0,0 +1,254 @@
+=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 SfvbFlowStatusRequest
+    # active to enroll customers as they trigger it, inactive to stop.
+    attr_accessor :status
+
+    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
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'status' => :'status'
+      }
+    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
+      {
+        :'status' => :'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::SfvbFlowStatusRequest` 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::SfvbFlowStatusRequest`. 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?(:'status')
+        self.status = attributes[:'status']
+      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?
+      status_validator = EnumAttributeValidator.new('String', ["active", "inactive"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["active", "inactive"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          status == o.status
+    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
+      [status].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