ultracart_api 4.1.208 → 4.1.209

data/lib/ultracart_api/models/sfvb_flow_write_request.rb

@@ -0,0 +1,354 @@
+=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 SfvbFlowWriteRequest
+    # True when a customer may be in this flow more than once at a time.
+    attr_accessor :allow_multiple_concurrent_enrollments
+
+    # True to end the flow for a customer once they buy from one of its emails.
+    attr_accessor :end_once_customer_purchases
+
+    # True to end the flow for a customer once they buy from any source.
+    attr_accessor :end_once_customer_purchases_anywhere
+
+    # The flow name, 1 to 250 characters.  Required to create.
+    attr_accessor :name
+
+    # Days before a customer may enter again, 1 to 1095.  Only with after_days.
+    attr_accessor :reentry_delay_days
+
+    # Whether a customer may enter again, anytime, after_days or never.
+    attr_accessor :reentry_policy
+
+    # The sending domain uuid.  Defaults to the storefront's marketing sending domain.
+    attr_accessor :sending_domain_uuid
+
+    # The from name.  Defaults to the storefront's marketing setting.
+    attr_accessor :sending_name
+
+    # 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.
+    attr_accessor :trigger_parameter
+
+    # What enrolls a customer, such as cart abandoned.  Create only.
+    attr_accessor :trigger_type
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'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',
+        :'name' => :'name',
+        :'reentry_delay_days' => :'reentry_delay_days',
+        :'reentry_policy' => :'reentry_policy',
+        :'sending_domain_uuid' => :'sending_domain_uuid',
+        :'sending_name' => :'sending_name',
+        :'sending_user' => :'sending_user',
+        :'trigger_parameter' => :'trigger_parameter',
+        :'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
+      {
+        :'allow_multiple_concurrent_enrollments' => :'Boolean',
+        :'end_once_customer_purchases' => :'Boolean',
+        :'end_once_customer_purchases_anywhere' => :'Boolean',
+        :'name' => :'String',
+        :'reentry_delay_days' => :'Integer',
+        :'reentry_policy' => :'String',
+        :'sending_domain_uuid' => :'String',
+        :'sending_name' => :'String',
+        :'sending_user' => :'String',
+        :'trigger_parameter' => :'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::SfvbFlowWriteRequest` 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::SfvbFlowWriteRequest`. 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?(:'allow_multiple_concurrent_enrollments')
+        self.allow_multiple_concurrent_enrollments = attributes[:'allow_multiple_concurrent_enrollments']
+      end
+
+      if attributes.key?(:'end_once_customer_purchases')
+        self.end_once_customer_purchases = attributes[:'end_once_customer_purchases']
+      end
+
+      if attributes.key?(:'end_once_customer_purchases_anywhere')
+        self.end_once_customer_purchases_anywhere = attributes[:'end_once_customer_purchases_anywhere']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'reentry_delay_days')
+        self.reentry_delay_days = attributes[:'reentry_delay_days']
+      end
+
+      if attributes.key?(:'reentry_policy')
+        self.reentry_policy = attributes[:'reentry_policy']
+      end
+
+      if attributes.key?(:'sending_domain_uuid')
+        self.sending_domain_uuid = attributes[:'sending_domain_uuid']
+      end
+
+      if attributes.key?(:'sending_name')
+        self.sending_name = attributes[:'sending_name']
+      end
+
+      if attributes.key?(:'sending_user')
+        self.sending_user = attributes[:'sending_user']
+      end
+
+      if attributes.key?(:'trigger_parameter')
+        self.trigger_parameter = attributes[:'trigger_parameter']
+      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?
+      reentry_policy_validator = EnumAttributeValidator.new('String', ["anytime", "after_days", "never"])
+      return false unless reentry_policy_validator.valid?(@reentry_policy)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] reentry_policy Object to be assigned
+    def reentry_policy=(reentry_policy)
+      validator = EnumAttributeValidator.new('String', ["anytime", "after_days", "never"])
+      unless validator.valid?(reentry_policy)
+        fail ArgumentError, "invalid value for \"reentry_policy\", must be one of #{validator.allowable_values}."
+      end
+      @reentry_policy = reentry_policy
+    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 &&
+          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 &&
+          name == o.name &&
+          reentry_delay_days == o.reentry_delay_days &&
+          reentry_policy == o.reentry_policy &&
+          sending_domain_uuid == o.sending_domain_uuid &&
+          sending_name == o.sending_name &&
+          sending_user == o.sending_user &&
+          trigger_parameter == o.trigger_parameter &&
+          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
+      [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
+    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.208'
+  VERSION = '4.1.209'
 end

data/lib/ultracart_api.rb

@@ -990,6 +990,7 @@ require 'ultracart_api/models/sfvb_approval_params'
 require 'ultracart_api/models/sfvb_approval_review'
 require 'ultracart_api/models/sfvb_approval_review_finding'
 require 'ultracart_api/models/sfvb_approvals_response'
+require 'ultracart_api/models/sfvb_archive_request'
 require 'ultracart_api/models/sfvb_blog_post'
 require 'ultracart_api/models/sfvb_blog_post_detail'
 require 'ultracart_api/models/sfvb_blog_post_image'
@@ -997,10 +998,16 @@ 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_campaign_membership'
+require 'ultracart_api/models/sfvb_campaign_write_request'
 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_list'
+require 'ultracart_api/models/sfvb_comms_lists_response'
 require 'ultracart_api/models/sfvb_comms_postcard'
+require 'ultracart_api/models/sfvb_comms_segment'
+require 'ultracart_api/models/sfvb_comms_segments_response'
 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'
@@ -1045,6 +1052,8 @@ 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_flow_status_request'
+require 'ultracart_api/models/sfvb_flow_write_request'
 require 'ultracart_api/models/sfvb_flows_response'
 require 'ultracart_api/models/sfvb_i18n_glossary'
 require 'ultracart_api/models/sfvb_i18n_glossary_request'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.208
+  version: 4.1.209
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-26 00:00:00.000000000 Z
+date: 2026-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1052,6 +1052,7 @@ files:
 - docs/SfvbApprovalReview.md
 - docs/SfvbApprovalReviewFinding.md
 - docs/SfvbApprovalsResponse.md
+- docs/SfvbArchiveRequest.md
 - docs/SfvbBlogPost.md
 - docs/SfvbBlogPostDetail.md
 - docs/SfvbBlogPostImage.md
@@ -1059,10 +1060,16 @@ files:
 - docs/SfvbBlogPostRequest.md
 - docs/SfvbBlogPostsResponse.md
 - docs/SfvbCampaign.md
+- docs/SfvbCampaignMembership.md
+- docs/SfvbCampaignWriteRequest.md
 - docs/SfvbCampaignsResponse.md
 - docs/SfvbCommsDnsRecord.md
 - docs/SfvbCommsEmail.md
+- docs/SfvbCommsList.md
+- docs/SfvbCommsListsResponse.md
 - docs/SfvbCommsPostcard.md
+- docs/SfvbCommsSegment.md
+- docs/SfvbCommsSegmentsResponse.md
 - docs/SfvbCommsSendingDomain.md
 - docs/SfvbCommsSendingDomainsResponse.md
 - docs/SfvbCommsTwilioAccount.md
@@ -1107,6 +1114,8 @@ files:
 - docs/SfvbFileWriteResponse.md
 - docs/SfvbFilesResponse.md
 - docs/SfvbFlow.md
+- docs/SfvbFlowStatusRequest.md
+- docs/SfvbFlowWriteRequest.md
 - docs/SfvbFlowsResponse.md
 - docs/SfvbI18nGlossary.md
 - docs/SfvbI18nGlossaryRequest.md
@@ -2385,6 +2394,7 @@ files:
 - lib/ultracart_api/models/sfvb_approval_review.rb
 - lib/ultracart_api/models/sfvb_approval_review_finding.rb
 - lib/ultracart_api/models/sfvb_approvals_response.rb
+- lib/ultracart_api/models/sfvb_archive_request.rb
 - lib/ultracart_api/models/sfvb_blog_post.rb
 - lib/ultracart_api/models/sfvb_blog_post_detail.rb
 - lib/ultracart_api/models/sfvb_blog_post_image.rb
@@ -2392,10 +2402,16 @@ files:
 - 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_campaign_membership.rb
+- lib/ultracart_api/models/sfvb_campaign_write_request.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_list.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
+- lib/ultracart_api/models/sfvb_comms_segments_response.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
@@ -2440,6 +2456,8 @@ files:
 - 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_flow_status_request.rb
+- lib/ultracart_api/models/sfvb_flow_write_request.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