ultracart_api 4.1.229 → 4.1.230

data/lib/ultracart_api/models/sfvb_comms_list_write_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 SfvbCommsListWriteRequest
+    # A list and segment folder on this storefront, or an empty string for none.
+    attr_accessor :folder_uuid
+
+    # The list name, 1 to 250 characters.  Required to create.
+    attr_accessor :name
+
+    # Plain text subscribers see for a public list, up to 100 characters, or an empty string for none.
+    attr_accessor :public_description
+
+    # True to let subscribers choose this list on the storefront's email preferences page.  Defaults to false.
+    attr_accessor :public_list
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'folder_uuid' => :'folder_uuid',
+        :'name' => :'name',
+        :'public_description' => :'public_description',
+        :'public_list' => :'public_list'
+      }
+    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
+      {
+        :'folder_uuid' => :'String',
+        :'name' => :'String',
+        :'public_description' => :'String',
+        :'public_list' => :'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::SfvbCommsListWriteRequest` 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::SfvbCommsListWriteRequest`. 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?(:'folder_uuid')
+        self.folder_uuid = attributes[:'folder_uuid']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'public_description')
+        self.public_description = attributes[:'public_description']
+      end
+
+      if attributes.key?(:'public_list')
+        self.public_list = attributes[:'public_list']
+      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 &&
+          folder_uuid == o.folder_uuid &&
+          name == o.name &&
+          public_description == o.public_description &&
+          public_list == o.public_list
+    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
+      [folder_uuid, name, public_description, public_list].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

@@ -42,10 +42,10 @@ module UltracartClient
     # The part of the from address before the at sign.  Defaults to the storefront's marketing setting.
     attr_accessor :sending_user
 
-    # The list or segment uuid for a list or segment trigger.  Create only.
+    # The list or segment uuid for a list or segment trigger.  Cleared when the trigger changes to one that takes none.
     attr_accessor :trigger_parameter
 
-    # What enrolls a customer, such as cart abandoned.  Create only.
+    # What enrolls a customer, such as cart abandoned.  Required to create.  On a change, only while the flow is off.
     attr_accessor :trigger_type
 
     class EnumAttributeValidator

data/lib/ultracart_api/models/sfvb_sequence_step.rb

@@ -36,7 +36,7 @@ module UltracartClient
     # The step's audience filter as stored, when it has one.
     attr_accessor :filter_profile_equation_json
 
-    # The hash of the step's type, stored settings and audience filter.  Send it back as If-Match when changing the step.
+    # The hash of the step's type, stored settings and audience filter.  Send it back as If-Match when changing the step.  What a running flow records in the settings (a resend step's resend mappings, a rate limiter's inventory refresh time, an experiment's winner) doesn't count.  An email step's smartSending and magicLink are the email's own settings, so the email's hash_sha256 guards them, not this one.
     attr_accessor :hash_sha256
 
     # The items it names, for a cart or rate limiter step.

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) 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) or step (this step, the last 90 days).
     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.229'
+  VERSION = '4.1.230'
 end

data/lib/ultracart_api.rb

@@ -1008,7 +1008,15 @@ require 'ultracart_api/models/sfvb_code_library_email'
 require 'ultracart_api/models/sfvb_code_library_emails_response'
 require 'ultracart_api/models/sfvb_comms_dns_record'
 require 'ultracart_api/models/sfvb_comms_email'
+require 'ultracart_api/models/sfvb_comms_folder'
+require 'ultracart_api/models/sfvb_comms_folder_item'
+require 'ultracart_api/models/sfvb_comms_folder_response'
+require 'ultracart_api/models/sfvb_comms_folder_write_request'
+require 'ultracart_api/models/sfvb_comms_folders_response'
 require 'ultracart_api/models/sfvb_comms_list'
+require 'ultracart_api/models/sfvb_comms_list_detail'
+require 'ultracart_api/models/sfvb_comms_list_response'
+require 'ultracart_api/models/sfvb_comms_list_write_request'
 require 'ultracart_api/models/sfvb_comms_lists_response'
 require 'ultracart_api/models/sfvb_comms_postcard'
 require 'ultracart_api/models/sfvb_comms_segment'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.229
+  version: 4.1.230
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-11-04 00:00:00.000000000 Z
+date: 2026-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1070,7 +1070,15 @@ files:
 - docs/SfvbCodeLibraryEmailsResponse.md
 - docs/SfvbCommsDnsRecord.md
 - docs/SfvbCommsEmail.md
+- docs/SfvbCommsFolder.md
+- docs/SfvbCommsFolderItem.md
+- docs/SfvbCommsFolderResponse.md
+- docs/SfvbCommsFolderWriteRequest.md
+- docs/SfvbCommsFoldersResponse.md
 - docs/SfvbCommsList.md
+- docs/SfvbCommsListDetail.md
+- docs/SfvbCommsListResponse.md
+- docs/SfvbCommsListWriteRequest.md
 - docs/SfvbCommsListsResponse.md
 - docs/SfvbCommsPostcard.md
 - docs/SfvbCommsSegment.md
@@ -2472,7 +2480,15 @@ files:
 - lib/ultracart_api/models/sfvb_code_library_emails_response.rb
 - lib/ultracart_api/models/sfvb_comms_dns_record.rb
 - lib/ultracart_api/models/sfvb_comms_email.rb
+- lib/ultracart_api/models/sfvb_comms_folder.rb
+- lib/ultracart_api/models/sfvb_comms_folder_item.rb
+- lib/ultracart_api/models/sfvb_comms_folder_response.rb
+- lib/ultracart_api/models/sfvb_comms_folder_write_request.rb
+- lib/ultracart_api/models/sfvb_comms_folders_response.rb
 - lib/ultracart_api/models/sfvb_comms_list.rb
+- lib/ultracart_api/models/sfvb_comms_list_detail.rb
+- lib/ultracart_api/models/sfvb_comms_list_response.rb
+- lib/ultracart_api/models/sfvb_comms_list_write_request.rb
 - lib/ultracart_api/models/sfvb_comms_lists_response.rb
 - lib/ultracart_api/models/sfvb_comms_postcard.rb
 - lib/ultracart_api/models/sfvb_comms_segment.rb