ultracart_api 4.1.206 → 4.1.208

data/lib/ultracart_api/models/sfvb_flow.rb

@@ -0,0 +1,334 @@
+=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 SfvbFlow
+    # The communication sequence the steps belong to.
+    attr_accessor :communication_sequence_uuid
+
+    # When the flow was created (ISO 8601, UTC).
+    attr_accessor :created_dts
+
+    # True when the flow was deleted.
+    attr_accessor :deleted
+
+    # Its emails, in step order.
+    attr_accessor :emails
+
+    # The flow uuid.
+    attr_accessor :flow_uuid
+
+    # 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
+
+    # Its postcards, in step order.
+    attr_accessor :postcards
+
+    # 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 name of the trigger parameter, when the trigger takes one.
+    attr_accessor :trigger_parameter_name
+
+    # What starts the flow, such as cart abandon or an order.
+    attr_accessor :trigger_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'communication_sequence_uuid' => :'communication_sequence_uuid',
+        :'created_dts' => :'created_dts',
+        :'deleted' => :'deleted',
+        :'emails' => :'emails',
+        :'flow_uuid' => :'flow_uuid',
+        :'live' => :'live',
+        :'name' => :'name',
+        :'postcards' => :'postcards',
+        :'status' => :'status',
+        :'status_dts' => :'status_dts',
+        :'trigger_parameter_name' => :'trigger_parameter_name',
+        :'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
+      {
+        :'communication_sequence_uuid' => :'String',
+        :'created_dts' => :'String',
+        :'deleted' => :'Boolean',
+        :'emails' => :'Array<SfvbCommsEmail>',
+        :'flow_uuid' => :'String',
+        :'live' => :'Boolean',
+        :'name' => :'String',
+        :'postcards' => :'Array<SfvbCommsPostcard>',
+        :'status' => :'String',
+        :'status_dts' => :'String',
+        :'trigger_parameter_name' => :'String',
+        :'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::SfvbFlow` 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::SfvbFlow`. 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?(:'communication_sequence_uuid')
+        self.communication_sequence_uuid = attributes[:'communication_sequence_uuid']
+      end
+
+      if attributes.key?(:'created_dts')
+        self.created_dts = attributes[:'created_dts']
+      end
+
+      if attributes.key?(:'deleted')
+        self.deleted = attributes[:'deleted']
+      end
+
+      if attributes.key?(:'emails')
+        if (value = attributes[:'emails']).is_a?(Array)
+          self.emails = value
+        end
+      end
+
+      if attributes.key?(:'flow_uuid')
+        self.flow_uuid = attributes[:'flow_uuid']
+      end
+
+      if attributes.key?(:'live')
+        self.live = attributes[:'live']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'postcards')
+        if (value = attributes[:'postcards']).is_a?(Array)
+          self.postcards = value
+        end
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'status_dts')
+        self.status_dts = attributes[:'status_dts']
+      end
+
+      if attributes.key?(:'trigger_parameter_name')
+        self.trigger_parameter_name = attributes[:'trigger_parameter_name']
+      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 &&
+          communication_sequence_uuid == o.communication_sequence_uuid &&
+          created_dts == o.created_dts &&
+          deleted == o.deleted &&
+          emails == o.emails &&
+          flow_uuid == o.flow_uuid &&
+          live == o.live &&
+          name == o.name &&
+          postcards == o.postcards &&
+          status == o.status &&
+          status_dts == o.status_dts &&
+          trigger_parameter_name == o.trigger_parameter_name &&
+          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
+      [communication_sequence_uuid, created_dts, deleted, emails, flow_uuid, live, name, postcards, status, status_dts, trigger_parameter_name, 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_flows_response.rb

@@ -0,0 +1,252 @@
+=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 SfvbFlowsResponse
+    # The flows on this page, newest first.
+    attr_accessor :flows
+
+    # This page number, starting at 1.
+    attr_accessor :page
+
+    # The page size.
+    attr_accessor :page_size
+
+    # How many match, across every page.
+    attr_accessor :total
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'flows' => :'flows',
+        :'page' => :'page',
+        :'page_size' => :'page_size',
+        :'total' => :'total'
+      }
+    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
+      {
+        :'flows' => :'Array<SfvbFlow>',
+        :'page' => :'Integer',
+        :'page_size' => :'Integer',
+        :'total' => :'Integer'
+      }
+    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::SfvbFlowsResponse` 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::SfvbFlowsResponse`. 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?(:'flows')
+        if (value = attributes[:'flows']).is_a?(Array)
+          self.flows = value
+        end
+      end
+
+      if attributes.key?(:'page')
+        self.page = attributes[:'page']
+      end
+
+      if attributes.key?(:'page_size')
+        self.page_size = attributes[:'page_size']
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      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 &&
+          flows == o.flows &&
+          page == o.page &&
+          page_size == o.page_size &&
+          total == o.total
+    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
+      [flows, page, page_size, total].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.206'
+  VERSION = '4.1.208'
 end

data/lib/ultracart_api.rb

@@ -996,7 +996,11 @@ require 'ultracart_api/models/sfvb_blog_post_image'
 require 'ultracart_api/models/sfvb_blog_post_image_request'
 require 'ultracart_api/models/sfvb_blog_post_request'
 require 'ultracart_api/models/sfvb_blog_posts_response'
+require 'ultracart_api/models/sfvb_campaign'
+require 'ultracart_api/models/sfvb_campaigns_response'
 require 'ultracart_api/models/sfvb_comms_dns_record'
+require 'ultracart_api/models/sfvb_comms_email'
+require 'ultracart_api/models/sfvb_comms_postcard'
 require 'ultracart_api/models/sfvb_comms_sending_domain'
 require 'ultracart_api/models/sfvb_comms_sending_domains_response'
 require 'ultracart_api/models/sfvb_comms_twilio_account'
@@ -1011,8 +1015,10 @@ require 'ultracart_api/models/sfvb_container_write_request'
 require 'ultracart_api/models/sfvb_element'
 require 'ultracart_api/models/sfvb_element_schema_response'
 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_update_request'
 require 'ultracart_api/models/sfvb_error_detail'
 require 'ultracart_api/models/sfvb_event'
 require 'ultracart_api/models/sfvb_events_auth_request'
@@ -1038,6 +1044,8 @@ require 'ultracart_api/models/sfvb_file_versions_response'
 require 'ultracart_api/models/sfvb_file_write_request'
 require 'ultracart_api/models/sfvb_file_write_response'
 require 'ultracart_api/models/sfvb_files_response'
+require 'ultracart_api/models/sfvb_flow'
+require 'ultracart_api/models/sfvb_flows_response'
 require 'ultracart_api/models/sfvb_i18n_glossary'
 require 'ultracart_api/models/sfvb_i18n_glossary_request'
 require 'ultracart_api/models/sfvb_i18n_language'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.206
+  version: 4.1.208
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-16 00:00:00.000000000 Z
+date: 2026-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1058,7 +1058,11 @@ files:
 - docs/SfvbBlogPostImageRequest.md
 - docs/SfvbBlogPostRequest.md
 - docs/SfvbBlogPostsResponse.md
+- docs/SfvbCampaign.md
+- docs/SfvbCampaignsResponse.md
 - docs/SfvbCommsDnsRecord.md
+- docs/SfvbCommsEmail.md
+- docs/SfvbCommsPostcard.md
 - docs/SfvbCommsSendingDomain.md
 - docs/SfvbCommsSendingDomainsResponse.md
 - docs/SfvbCommsTwilioAccount.md
@@ -1073,8 +1077,10 @@ files:
 - docs/SfvbElement.md
 - docs/SfvbElementSchemaResponse.md
 - docs/SfvbElementsResponse.md
+- docs/SfvbEmail.md
 - docs/SfvbEmailRenderRequest.md
 - docs/SfvbEmailRenderResponse.md
+- docs/SfvbEmailUpdateRequest.md
 - docs/SfvbErrorDetail.md
 - docs/SfvbEvent.md
 - docs/SfvbEventsAuthRequest.md
@@ -1100,6 +1106,8 @@ files:
 - docs/SfvbFileWriteRequest.md
 - docs/SfvbFileWriteResponse.md
 - docs/SfvbFilesResponse.md
+- docs/SfvbFlow.md
+- docs/SfvbFlowsResponse.md
 - docs/SfvbI18nGlossary.md
 - docs/SfvbI18nGlossaryRequest.md
 - docs/SfvbI18nLanguage.md
@@ -2383,7 +2391,11 @@ files:
 - lib/ultracart_api/models/sfvb_blog_post_image_request.rb
 - lib/ultracart_api/models/sfvb_blog_post_request.rb
 - lib/ultracart_api/models/sfvb_blog_posts_response.rb
+- lib/ultracart_api/models/sfvb_campaign.rb
+- lib/ultracart_api/models/sfvb_campaigns_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_postcard.rb
 - lib/ultracart_api/models/sfvb_comms_sending_domain.rb
 - lib/ultracart_api/models/sfvb_comms_sending_domains_response.rb
 - lib/ultracart_api/models/sfvb_comms_twilio_account.rb
@@ -2398,8 +2410,10 @@ files:
 - lib/ultracart_api/models/sfvb_element.rb
 - lib/ultracart_api/models/sfvb_element_schema_response.rb
 - lib/ultracart_api/models/sfvb_elements_response.rb
+- 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_update_request.rb
 - lib/ultracart_api/models/sfvb_error_detail.rb
 - lib/ultracart_api/models/sfvb_event.rb
 - lib/ultracart_api/models/sfvb_events_auth_request.rb
@@ -2425,6 +2439,8 @@ files:
 - lib/ultracart_api/models/sfvb_file_write_request.rb
 - lib/ultracart_api/models/sfvb_file_write_response.rb
 - lib/ultracart_api/models/sfvb_files_response.rb
+- lib/ultracart_api/models/sfvb_flow.rb
+- lib/ultracart_api/models/sfvb_flows_response.rb
 - lib/ultracart_api/models/sfvb_i18n_glossary.rb
 - lib/ultracart_api/models/sfvb_i18n_glossary_request.rb
 - lib/ultracart_api/models/sfvb_i18n_language.rb