ultracart_api 4.1.209 → 4.1.211

data/lib/ultracart_api/models/sfvb_sequence_branch.rb

@@ -0,0 +1,232 @@
+=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 SfvbSequenceBranch
+    # yes or no for a condition, left or right for a split or an InboxGeek step.
+    attr_accessor :label
+
+    # The steps on this side, in order.
+    attr_accessor :steps
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'label' => :'label',
+        :'steps' => :'steps'
+      }
+    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
+      {
+        :'label' => :'String',
+        :'steps' => :'Array<SfvbSequenceStep>'
+      }
+    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::SfvbSequenceBranch` 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::SfvbSequenceBranch`. 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?(:'label')
+        self.label = attributes[:'label']
+      end
+
+      if attributes.key?(:'steps')
+        if (value = attributes[:'steps']).is_a?(Array)
+          self.steps = value
+        end
+      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 &&
+          label == o.label &&
+          steps == o.steps
+    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
+      [label, steps].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_sequence_step.rb

@@ -0,0 +1,388 @@
+=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 SfvbSequenceStep
+    # Its two sides, for a condition, split or InboxGeek step.  Absent for every other type.
+    attr_accessor :branches
+
+    # True when the step's settings could not be read.
+    attr_accessor :config_error
+
+    # The step's settings as the admin stores them.  A webhook's header and parameter values are masked.
+    attr_accessor :config_json
+
+    # A note stored inside the step's settings, when there is one.
+    attr_accessor :config_merchant_notes
+
+    # True when the step is switched off in its settings.
+    attr_accessor :disabled
+
+    # The emails it sends.  One for an email step, one per variant for an experiment.
+    attr_accessor :email_uuids
+
+    # The step's audience filter as stored, when it has one.
+    attr_accessor :filter_profile_equation_json
+
+    # The items it names, for a cart or rate limiter step.
+    attr_accessor :item_ids
+
+    # The type as the admin names it, such as Time Delay.  The type itself for one it doesn't know.
+    attr_accessor :label
+
+    # The lists it subscribes or unsubscribes, for a list step.
+    attr_accessor :list_uuids
+
+    # The note stored on the step.
+    attr_accessor :merchant_notes
+
+    # The step's own display name from its settings, when it has one.
+    attr_accessor :name
+
+    # How many customers are waiting on this step now.  Only when waiting counts were asked for.
+    attr_accessor :number_waiting
+
+    # The postcard it sends, for a postcard step.
+    attr_accessor :postcard_uuid
+
+    # The step uuid.
+    attr_accessor :step_uuid
+
+    # The step type, such as email, wait, condition or webhook.
+    attr_accessor :type
+
+    # True for a step no branch leads to.  Listed at the end so nothing is hidden.
+    attr_accessor :unreachable
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'branches' => :'branches',
+        :'config_error' => :'config_error',
+        :'config_json' => :'config_json',
+        :'config_merchant_notes' => :'config_merchant_notes',
+        :'disabled' => :'disabled',
+        :'email_uuids' => :'email_uuids',
+        :'filter_profile_equation_json' => :'filter_profile_equation_json',
+        :'item_ids' => :'item_ids',
+        :'label' => :'label',
+        :'list_uuids' => :'list_uuids',
+        :'merchant_notes' => :'merchant_notes',
+        :'name' => :'name',
+        :'number_waiting' => :'number_waiting',
+        :'postcard_uuid' => :'postcard_uuid',
+        :'step_uuid' => :'step_uuid',
+        :'type' => :'type',
+        :'unreachable' => :'unreachable'
+      }
+    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
+      {
+        :'branches' => :'Array<SfvbSequenceBranch>',
+        :'config_error' => :'Boolean',
+        :'config_json' => :'String',
+        :'config_merchant_notes' => :'String',
+        :'disabled' => :'Boolean',
+        :'email_uuids' => :'Array<String>',
+        :'filter_profile_equation_json' => :'String',
+        :'item_ids' => :'Array<String>',
+        :'label' => :'String',
+        :'list_uuids' => :'Array<String>',
+        :'merchant_notes' => :'String',
+        :'name' => :'String',
+        :'number_waiting' => :'Integer',
+        :'postcard_uuid' => :'String',
+        :'step_uuid' => :'String',
+        :'type' => :'String',
+        :'unreachable' => :'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::SfvbSequenceStep` 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::SfvbSequenceStep`. 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?(:'branches')
+        if (value = attributes[:'branches']).is_a?(Array)
+          self.branches = value
+        end
+      end
+
+      if attributes.key?(:'config_error')
+        self.config_error = attributes[:'config_error']
+      end
+
+      if attributes.key?(:'config_json')
+        self.config_json = attributes[:'config_json']
+      end
+
+      if attributes.key?(:'config_merchant_notes')
+        self.config_merchant_notes = attributes[:'config_merchant_notes']
+      end
+
+      if attributes.key?(:'disabled')
+        self.disabled = attributes[:'disabled']
+      end
+
+      if attributes.key?(:'email_uuids')
+        if (value = attributes[:'email_uuids']).is_a?(Array)
+          self.email_uuids = value
+        end
+      end
+
+      if attributes.key?(:'filter_profile_equation_json')
+        self.filter_profile_equation_json = attributes[:'filter_profile_equation_json']
+      end
+
+      if attributes.key?(:'item_ids')
+        if (value = attributes[:'item_ids']).is_a?(Array)
+          self.item_ids = value
+        end
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      end
+
+      if attributes.key?(:'list_uuids')
+        if (value = attributes[:'list_uuids']).is_a?(Array)
+          self.list_uuids = value
+        end
+      end
+
+      if attributes.key?(:'merchant_notes')
+        self.merchant_notes = attributes[:'merchant_notes']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'number_waiting')
+        self.number_waiting = attributes[:'number_waiting']
+      end
+
+      if attributes.key?(:'postcard_uuid')
+        self.postcard_uuid = attributes[:'postcard_uuid']
+      end
+
+      if attributes.key?(:'step_uuid')
+        self.step_uuid = attributes[:'step_uuid']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'unreachable')
+        self.unreachable = attributes[:'unreachable']
+      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 &&
+          branches == o.branches &&
+          config_error == o.config_error &&
+          config_json == o.config_json &&
+          config_merchant_notes == o.config_merchant_notes &&
+          disabled == o.disabled &&
+          email_uuids == o.email_uuids &&
+          filter_profile_equation_json == o.filter_profile_equation_json &&
+          item_ids == o.item_ids &&
+          label == o.label &&
+          list_uuids == o.list_uuids &&
+          merchant_notes == o.merchant_notes &&
+          name == o.name &&
+          number_waiting == o.number_waiting &&
+          postcard_uuid == o.postcard_uuid &&
+          step_uuid == o.step_uuid &&
+          type == o.type &&
+          unreachable == o.unreachable
+    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
+      [branches, config_error, config_json, config_merchant_notes, disabled, email_uuids, filter_profile_equation_json, item_ids, label, list_uuids, merchant_notes, name, number_waiting, postcard_uuid, step_uuid, type, unreachable].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/version.rb

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

data/lib/ultracart_api.rb

@@ -1025,6 +1025,7 @@ require 'ultracart_api/models/sfvb_elements_response'
 require 'ultracart_api/models/sfvb_email'
 require 'ultracart_api/models/sfvb_email_render_request'
 require 'ultracart_api/models/sfvb_email_render_response'
+require 'ultracart_api/models/sfvb_email_review_request'
 require 'ultracart_api/models/sfvb_email_update_request'
 require 'ultracart_api/models/sfvb_error_detail'
 require 'ultracart_api/models/sfvb_event'
@@ -1184,6 +1185,9 @@ require 'ultracart_api/models/sfvb_secret_request'
 require 'ultracart_api/models/sfvb_secret_request_create'
 require 'ultracart_api/models/sfvb_secret_requests_response'
 require 'ultracart_api/models/sfvb_secret_sink'
+require 'ultracart_api/models/sfvb_sequence'
+require 'ultracart_api/models/sfvb_sequence_branch'
+require 'ultracart_api/models/sfvb_sequence_step'
 require 'ultracart_api/models/sfvb_server_log'
 require 'ultracart_api/models/sfvb_server_log_detail'
 require 'ultracart_api/models/sfvb_server_log_entry'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.209
+  version: 4.1.211
 platform: ruby
 authors:
 - UltraCart
@@ -1087,6 +1087,7 @@ files:
 - docs/SfvbEmail.md
 - docs/SfvbEmailRenderRequest.md
 - docs/SfvbEmailRenderResponse.md
+- docs/SfvbEmailReviewRequest.md
 - docs/SfvbEmailUpdateRequest.md
 - docs/SfvbErrorDetail.md
 - docs/SfvbEvent.md
@@ -1246,6 +1247,9 @@ files:
 - docs/SfvbSecretRequestCreate.md
 - docs/SfvbSecretRequestsResponse.md
 - docs/SfvbSecretSink.md
+- docs/SfvbSequence.md
+- docs/SfvbSequenceBranch.md
+- docs/SfvbSequenceStep.md
 - docs/SfvbServerLog.md
 - docs/SfvbServerLogDetail.md
 - docs/SfvbServerLogEntry.md
@@ -2429,6 +2433,7 @@ files:
 - lib/ultracart_api/models/sfvb_email.rb
 - lib/ultracart_api/models/sfvb_email_render_request.rb
 - lib/ultracart_api/models/sfvb_email_render_response.rb
+- lib/ultracart_api/models/sfvb_email_review_request.rb
 - lib/ultracart_api/models/sfvb_email_update_request.rb
 - lib/ultracart_api/models/sfvb_error_detail.rb
 - lib/ultracart_api/models/sfvb_event.rb
@@ -2588,6 +2593,9 @@ files:
 - lib/ultracart_api/models/sfvb_secret_request_create.rb
 - lib/ultracart_api/models/sfvb_secret_requests_response.rb
 - lib/ultracart_api/models/sfvb_secret_sink.rb
+- lib/ultracart_api/models/sfvb_sequence.rb
+- lib/ultracart_api/models/sfvb_sequence_branch.rb
+- lib/ultracart_api/models/sfvb_sequence_step.rb
 - lib/ultracart_api/models/sfvb_server_log.rb
 - lib/ultracart_api/models/sfvb_server_log_detail.rb
 - lib/ultracart_api/models/sfvb_server_log_entry.rb