ultracart_api 4.1.219 → 4.1.221

data/lib/ultracart_api/models/sfvb_sequence_step_create_request.rb

@@ -15,29 +15,45 @@ require 'time'
 
 module UltracartClient
   class SfvbSequenceStepCreateRequest
+    # With library_item_oid, true once the caller has seen that the item carries executable content (script, html, embed, css or velocity elements) and still wants it.  An item with any is refused without it.
+    attr_accessor :acknowledge_executable
+
     # The step the new step follows, in the same list.  Not an end, continue or merge step.
     attr_accessor :after_step_uuid
 
     # A condition, split or inboxgeek step.  With side, the new step goes first on that side.
     attr_accessor :branch_step_uuid
 
-    # The new email's preview text, 5 to 150 characters.
+    # A wait step's settings, as the admin saves them and set-config changes them, namely delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), and optionally the delay_until_* options.  Not for an email step.
+    attr_accessor :config_json
+
+    # An email item from the code library (#1589) to start the new email from, taking its body, with new element ids, and its subject and preview text unless subject or preview_text is given.  The item must be this account's own, shared with it, or published, approved by UltraCart and free.  Only for an email step.  The items are listed by the code library email read.
+    attr_accessor :library_item_oid
+
+    # A post_card step's name, shown in the admin, 1 to 100 characters on one line.  Postcard by default.  Only for a post_card step.
+    attr_accessor :name
+
+    # The new email's preview text, 5 to 150 characters.  Optional with library_item_oid, whose preview text is used when this is left out.
     attr_accessor :preview_text
 
     # With branch_step_uuid, the side's label from the sequence read.  yes or no for a condition, left or right for a split or inboxgeek step.
     attr_accessor :side
 
-    # The new email's subject line, 5 to 150 characters.
+    # The new email's subject line, 5 to 150 characters.  Optional with library_item_oid, whose subject is used when this is left out.
     attr_accessor :subject
 
-    # The kind of step.  Only email for now.
+    # The kind of step, one of email (the default), wait or post_card.
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'acknowledge_executable' => :'acknowledge_executable',
         :'after_step_uuid' => :'after_step_uuid',
         :'branch_step_uuid' => :'branch_step_uuid',
+        :'config_json' => :'config_json',
+        :'library_item_oid' => :'library_item_oid',
+        :'name' => :'name',
         :'preview_text' => :'preview_text',
         :'side' => :'side',
         :'subject' => :'subject',
@@ -53,8 +69,12 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'acknowledge_executable' => :'Boolean',
         :'after_step_uuid' => :'String',
         :'branch_step_uuid' => :'String',
+        :'config_json' => :'String',
+        :'library_item_oid' => :'Integer',
+        :'name' => :'String',
         :'preview_text' => :'String',
         :'side' => :'String',
         :'subject' => :'String',
@@ -83,6 +103,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'acknowledge_executable')
+        self.acknowledge_executable = attributes[:'acknowledge_executable']
+      end
+
       if attributes.key?(:'after_step_uuid')
         self.after_step_uuid = attributes[:'after_step_uuid']
       end
@@ -91,6 +115,18 @@ module UltracartClient
         self.branch_step_uuid = attributes[:'branch_step_uuid']
       end
 
+      if attributes.key?(:'config_json')
+        self.config_json = attributes[:'config_json']
+      end
+
+      if attributes.key?(:'library_item_oid')
+        self.library_item_oid = attributes[:'library_item_oid']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
       if attributes.key?(:'preview_text')
         self.preview_text = attributes[:'preview_text']
       end
@@ -126,8 +162,12 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          acknowledge_executable == o.acknowledge_executable &&
           after_step_uuid == o.after_step_uuid &&
           branch_step_uuid == o.branch_step_uuid &&
+          config_json == o.config_json &&
+          library_item_oid == o.library_item_oid &&
+          name == o.name &&
           preview_text == o.preview_text &&
           side == o.side &&
           subject == o.subject &&
@@ -143,7 +183,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [after_step_uuid, branch_step_uuid, preview_text, side, subject, type].hash
+      [acknowledge_executable, after_step_uuid, branch_step_uuid, config_json, library_item_oid, name, preview_text, side, subject, type].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_sequence_step_create_response.rb

@@ -15,12 +15,33 @@ require 'time'
 
 module UltracartClient
   class SfvbSequenceStepCreateResponse
+    # A post_card step's back, the container with owner type postcardback and this owner id.
+    attr_accessor :back_container_uuid
+
     # The new email's uuid.  Its body is the email container with this owner id.
     attr_accessor :email_uuid
 
+    # A post_card step's front, the container with owner type postcardfront and this owner id.
+    attr_accessor :front_container_uuid
+
+    # The library item's files whose path already held a file, which was kept, not replaced.
+    attr_accessor :library_files_kept
+
+    # The library item's files that weren't written because they aren't a PNG, JPEG or GIF image whose bytes match its name.  Only those images are copied from a library item.
+    attr_accessor :library_files_skipped
+
+    # Storefront file paths the library item's files were written to.  A file already at its path is kept as it is and listed in library_files_kept instead.
+    attr_accessor :library_files_written
+
+    # The code library email item the new email started from (#1589), when one was given.
+    attr_accessor :library_item_oid
+
     # What to do next, such as writing the body, and customers already waiting on the step before it.
     attr_accessor :notes
 
+    # A post_card step's new postcard (#1644).
+    attr_accessor :postcard_uuid
+
     # True when the new email must pass content review before it sends.
     attr_accessor :requires_review
 
@@ -29,8 +50,15 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'back_container_uuid' => :'back_container_uuid',
         :'email_uuid' => :'email_uuid',
+        :'front_container_uuid' => :'front_container_uuid',
+        :'library_files_kept' => :'library_files_kept',
+        :'library_files_skipped' => :'library_files_skipped',
+        :'library_files_written' => :'library_files_written',
+        :'library_item_oid' => :'library_item_oid',
         :'notes' => :'notes',
+        :'postcard_uuid' => :'postcard_uuid',
         :'requires_review' => :'requires_review',
         :'step' => :'step'
       }
@@ -44,8 +72,15 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'back_container_uuid' => :'String',
         :'email_uuid' => :'String',
+        :'front_container_uuid' => :'String',
+        :'library_files_kept' => :'Array<String>',
+        :'library_files_skipped' => :'Array<String>',
+        :'library_files_written' => :'Array<String>',
+        :'library_item_oid' => :'Integer',
         :'notes' => :'Array<String>',
+        :'postcard_uuid' => :'String',
         :'requires_review' => :'Boolean',
         :'step' => :'SfvbSequenceStep'
       }
@@ -72,16 +107,50 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'back_container_uuid')
+        self.back_container_uuid = attributes[:'back_container_uuid']
+      end
+
       if attributes.key?(:'email_uuid')
         self.email_uuid = attributes[:'email_uuid']
       end
 
+      if attributes.key?(:'front_container_uuid')
+        self.front_container_uuid = attributes[:'front_container_uuid']
+      end
+
+      if attributes.key?(:'library_files_kept')
+        if (value = attributes[:'library_files_kept']).is_a?(Array)
+          self.library_files_kept = value
+        end
+      end
+
+      if attributes.key?(:'library_files_skipped')
+        if (value = attributes[:'library_files_skipped']).is_a?(Array)
+          self.library_files_skipped = value
+        end
+      end
+
+      if attributes.key?(:'library_files_written')
+        if (value = attributes[:'library_files_written']).is_a?(Array)
+          self.library_files_written = value
+        end
+      end
+
+      if attributes.key?(:'library_item_oid')
+        self.library_item_oid = attributes[:'library_item_oid']
+      end
+
       if attributes.key?(:'notes')
         if (value = attributes[:'notes']).is_a?(Array)
           self.notes = value
         end
       end
 
+      if attributes.key?(:'postcard_uuid')
+        self.postcard_uuid = attributes[:'postcard_uuid']
+      end
+
       if attributes.key?(:'requires_review')
         self.requires_review = attributes[:'requires_review']
       end
@@ -109,8 +178,15 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          back_container_uuid == o.back_container_uuid &&
           email_uuid == o.email_uuid &&
+          front_container_uuid == o.front_container_uuid &&
+          library_files_kept == o.library_files_kept &&
+          library_files_skipped == o.library_files_skipped &&
+          library_files_written == o.library_files_written &&
+          library_item_oid == o.library_item_oid &&
           notes == o.notes &&
+          postcard_uuid == o.postcard_uuid &&
           requires_review == o.requires_review &&
           step == o.step
     end
@@ -124,7 +200,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email_uuid, notes, requires_review, step].hash
+      [back_container_uuid, email_uuid, front_container_uuid, library_files_kept, library_files_skipped, library_files_written, library_item_oid, notes, postcard_uuid, requires_review, step].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_sequence_step_move_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 SfvbSequenceStepMoveRequest
+    # The step it moves after, in that step's list.  The begin step puts it first in the sequence.  Not an end, continue or merge step.
+    attr_accessor :after_step_uuid
+
+    # The hash_sha256 of after_step_uuid, or of branch_step_uuid, from the last read.  Required; 412 when stale.
+    attr_accessor :anchor_hash_sha256
+
+    # A condition, split or inboxgeek step.  With side, the step moves to the start of that side.
+    attr_accessor :branch_step_uuid
+
+    # With branch_step_uuid, the side's label from the sequence read.  yes or no for a condition, left or right for a split or inboxgeek step.
+    attr_accessor :side
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'after_step_uuid' => :'after_step_uuid',
+        :'anchor_hash_sha256' => :'anchor_hash_sha256',
+        :'branch_step_uuid' => :'branch_step_uuid',
+        :'side' => :'side'
+      }
+    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
+      {
+        :'after_step_uuid' => :'String',
+        :'anchor_hash_sha256' => :'String',
+        :'branch_step_uuid' => :'String',
+        :'side' => :'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::SfvbSequenceStepMoveRequest` 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::SfvbSequenceStepMoveRequest`. 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?(:'after_step_uuid')
+        self.after_step_uuid = attributes[:'after_step_uuid']
+      end
+
+      if attributes.key?(:'anchor_hash_sha256')
+        self.anchor_hash_sha256 = attributes[:'anchor_hash_sha256']
+      end
+
+      if attributes.key?(:'branch_step_uuid')
+        self.branch_step_uuid = attributes[:'branch_step_uuid']
+      end
+
+      if attributes.key?(:'side')
+        self.side = attributes[:'side']
+      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 &&
+          after_step_uuid == o.after_step_uuid &&
+          anchor_hash_sha256 == o.anchor_hash_sha256 &&
+          branch_step_uuid == o.branch_step_uuid &&
+          side == o.side
+    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
+      [after_step_uuid, anchor_hash_sha256, branch_step_uuid, side].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