ultracart_api 4.1.231 → 4.1.233

data/lib/ultracart_api/models/sfvb_flow_backfill_request.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 SfvbFlowBackfillRequest
+    # Count who would be enrolled and enroll nobody.
+    attr_accessor :dry_run
+
+    # The flow.  Used by a flow.backfill approval request.  The backfill call takes it from the path.
+    attr_accessor :flow_uuid
+
+    # For an order trigger, how many days of orders to enroll, 1 to 90 (default 5).
+    attr_accessor :order_days_old
+
+    # For an order trigger, shorten the flow's first wait by each order's age.
+    attr_accessor :relative_to_event
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'dry_run' => :'dry_run',
+        :'flow_uuid' => :'flow_uuid',
+        :'order_days_old' => :'order_days_old',
+        :'relative_to_event' => :'relative_to_event'
+      }
+    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
+      {
+        :'dry_run' => :'Boolean',
+        :'flow_uuid' => :'String',
+        :'order_days_old' => :'Integer',
+        :'relative_to_event' => :'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::SfvbFlowBackfillRequest` 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::SfvbFlowBackfillRequest`. 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?(:'dry_run')
+        self.dry_run = attributes[:'dry_run']
+      end
+
+      if attributes.key?(:'flow_uuid')
+        self.flow_uuid = attributes[:'flow_uuid']
+      end
+
+      if attributes.key?(:'order_days_old')
+        self.order_days_old = attributes[:'order_days_old']
+      end
+
+      if attributes.key?(:'relative_to_event')
+        self.relative_to_event = attributes[:'relative_to_event']
+      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 &&
+          dry_run == o.dry_run &&
+          flow_uuid == o.flow_uuid &&
+          order_days_old == o.order_days_old &&
+          relative_to_event == o.relative_to_event
+    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
+      [dry_run, flow_uuid, order_days_old, relative_to_event].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_flow_backfill_response.rb

@@ -0,0 +1,322 @@
+=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 SfvbFlowBackfillResponse
+    # True when the plan's customer limit stopped the count.
+    attr_accessor :capped
+
+    # How many different customers those are.
+    attr_accessor :customers
+
+    # True when nothing was enrolled.
+    attr_accessor :dry_run
+
+    # How many enrollments the backfill makes (a purchased product trigger makes one per item).
+    attr_accessor :enrollments
+
+    # The flow.
+    attr_accessor :flow_uuid
+
+    # What happens next, in sentences.
+    attr_accessor :notes
+
+    # The days of orders, for an order trigger.
+    attr_accessor :order_days_old
+
+    # Whether the first wait is shortened by each order's age.
+    attr_accessor :relative_to_event
+
+    # True when the segment needs a rebuild, so the count is from its last one.
+    attr_accessor :segment_rebuild_required
+
+    # True when the backfill started in the background.  The signed-in user is emailed when it ends.
+    attr_accessor :started
+
+    # The flow's trigger.
+    attr_accessor :trigger_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'capped' => :'capped',
+        :'customers' => :'customers',
+        :'dry_run' => :'dry_run',
+        :'enrollments' => :'enrollments',
+        :'flow_uuid' => :'flow_uuid',
+        :'notes' => :'notes',
+        :'order_days_old' => :'order_days_old',
+        :'relative_to_event' => :'relative_to_event',
+        :'segment_rebuild_required' => :'segment_rebuild_required',
+        :'started' => :'started',
+        :'trigger_type' => :'trigger_type'
+      }
+    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
+      {
+        :'capped' => :'Boolean',
+        :'customers' => :'Integer',
+        :'dry_run' => :'Boolean',
+        :'enrollments' => :'Integer',
+        :'flow_uuid' => :'String',
+        :'notes' => :'Array<String>',
+        :'order_days_old' => :'Integer',
+        :'relative_to_event' => :'Boolean',
+        :'segment_rebuild_required' => :'Boolean',
+        :'started' => :'Boolean',
+        :'trigger_type' => :'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::SfvbFlowBackfillResponse` 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::SfvbFlowBackfillResponse`. 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?(:'capped')
+        self.capped = attributes[:'capped']
+      end
+
+      if attributes.key?(:'customers')
+        self.customers = attributes[:'customers']
+      end
+
+      if attributes.key?(:'dry_run')
+        self.dry_run = attributes[:'dry_run']
+      end
+
+      if attributes.key?(:'enrollments')
+        self.enrollments = attributes[:'enrollments']
+      end
+
+      if attributes.key?(:'flow_uuid')
+        self.flow_uuid = attributes[:'flow_uuid']
+      end
+
+      if attributes.key?(:'notes')
+        if (value = attributes[:'notes']).is_a?(Array)
+          self.notes = value
+        end
+      end
+
+      if attributes.key?(:'order_days_old')
+        self.order_days_old = attributes[:'order_days_old']
+      end
+
+      if attributes.key?(:'relative_to_event')
+        self.relative_to_event = attributes[:'relative_to_event']
+      end
+
+      if attributes.key?(:'segment_rebuild_required')
+        self.segment_rebuild_required = attributes[:'segment_rebuild_required']
+      end
+
+      if attributes.key?(:'started')
+        self.started = attributes[:'started']
+      end
+
+      if attributes.key?(:'trigger_type')
+        self.trigger_type = attributes[:'trigger_type']
+      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 &&
+          capped == o.capped &&
+          customers == o.customers &&
+          dry_run == o.dry_run &&
+          enrollments == o.enrollments &&
+          flow_uuid == o.flow_uuid &&
+          notes == o.notes &&
+          order_days_old == o.order_days_old &&
+          relative_to_event == o.relative_to_event &&
+          segment_rebuild_required == o.segment_rebuild_required &&
+          started == o.started &&
+          trigger_type == o.trigger_type
+    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
+      [capped, customers, dry_run, enrollments, flow_uuid, notes, order_days_old, relative_to_event, segment_rebuild_required, started, trigger_type].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_flow_write_request.rb

@@ -24,6 +24,9 @@ module UltracartClient
     # True to end the flow for a customer once they buy from any source.
     attr_accessor :end_once_customer_purchases_anywhere
 
+    # File it in this flow folder.  An empty value takes it out of its folder.
+    attr_accessor :folder_uuid
+
     # The flow name, 1 to 250 characters.  Required to create.
     attr_accessor :name
 
@@ -76,6 +79,7 @@ module UltracartClient
         :'allow_multiple_concurrent_enrollments' => :'allow_multiple_concurrent_enrollments',
         :'end_once_customer_purchases' => :'end_once_customer_purchases',
         :'end_once_customer_purchases_anywhere' => :'end_once_customer_purchases_anywhere',
+        :'folder_uuid' => :'folder_uuid',
         :'name' => :'name',
         :'reentry_delay_days' => :'reentry_delay_days',
         :'reentry_policy' => :'reentry_policy',
@@ -98,6 +102,7 @@ module UltracartClient
         :'allow_multiple_concurrent_enrollments' => :'Boolean',
         :'end_once_customer_purchases' => :'Boolean',
         :'end_once_customer_purchases_anywhere' => :'Boolean',
+        :'folder_uuid' => :'String',
         :'name' => :'String',
         :'reentry_delay_days' => :'Integer',
         :'reentry_policy' => :'String',
@@ -142,6 +147,10 @@ module UltracartClient
         self.end_once_customer_purchases_anywhere = attributes[:'end_once_customer_purchases_anywhere']
       end
 
+      if attributes.key?(:'folder_uuid')
+        self.folder_uuid = attributes[:'folder_uuid']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -208,6 +217,7 @@ module UltracartClient
           allow_multiple_concurrent_enrollments == o.allow_multiple_concurrent_enrollments &&
           end_once_customer_purchases == o.end_once_customer_purchases &&
           end_once_customer_purchases_anywhere == o.end_once_customer_purchases_anywhere &&
+          folder_uuid == o.folder_uuid &&
           name == o.name &&
           reentry_delay_days == o.reentry_delay_days &&
           reentry_policy == o.reentry_policy &&
@@ -227,7 +237,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [allow_multiple_concurrent_enrollments, end_once_customer_purchases, end_once_customer_purchases_anywhere, name, reentry_delay_days, reentry_policy, sending_domain_uuid, sending_name, sending_user, trigger_parameter, trigger_type].hash
+      [allow_multiple_concurrent_enrollments, end_once_customer_purchases, end_once_customer_purchases_anywhere, folder_uuid, name, reentry_delay_days, reentry_policy, sending_domain_uuid, sending_name, sending_user, trigger_parameter, trigger_type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_step_counts.rb

@@ -33,7 +33,7 @@ module UltracartClient
     # Customers who reached the step and were not sent anything.  The dispatch log says why.
     attr_accessor :skipped
 
-    # email (the step's email, all time), sequence (the begin step, customers who started the sequence, all time) or step (this step, the last 90 days).
+    # email (the step's email, all time), sequence (the begin step, customers who started the sequence, all time), resend (a Resend Email step, what it resent, the last 90 days), experiment (an experiment step, its variants together, the last 90 days), sms or postcard (the step's own sends, the last 90 days), step (the end step or a condition, split or InboxGeek step, the last 90 days) or not_recorded (a step type the send path keeps no counts for, such as a wait; no counts are given).
     attr_accessor :source
 
     # Spam complaints.

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.231'
+  VERSION = '4.1.233'
 end