ultracart_api 4.1.229 → 4.1.231

data/lib/ultracart_api/models/sfvb_comms_member.rb

@@ -0,0 +1,240 @@
+=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 SfvbCommsMember
+    # When the customer joined the list or segment.
+    attr_accessor :added_dts
+
+    # The customer uuid, the same on every list, segment and flow.
+    attr_accessor :customer_uuid
+
+    # The email address, masked as w***a@example.com unless show_customer_data was sent.
+    attr_accessor :email
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'added_dts' => :'added_dts',
+        :'customer_uuid' => :'customer_uuid',
+        :'email' => :'email'
+      }
+    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
+      {
+        :'added_dts' => :'String',
+        :'customer_uuid' => :'String',
+        :'email' => :'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::SfvbCommsMember` 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::SfvbCommsMember`. 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?(:'added_dts')
+        self.added_dts = attributes[:'added_dts']
+      end
+
+      if attributes.key?(:'customer_uuid')
+        self.customer_uuid = attributes[:'customer_uuid']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      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 &&
+          added_dts == o.added_dts &&
+          customer_uuid == o.customer_uuid &&
+          email == o.email
+    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
+      [added_dts, customer_uuid, email].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_comms_members_response.rb

@@ -0,0 +1,314 @@
+=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 SfvbCommsMembersResponse
+    # masked, or shown when show_customer_data was sent.
+    attr_accessor :customer_data
+
+    # The list, for a list's members.
+    attr_accessor :list_uuid
+
+    # This page of members.
+    attr_accessor :members
+
+    # What to keep in mind, such as how to handle customer data that is shown.
+    attr_accessor :notes
+
+    # The page number, from 1.
+    attr_accessor :page
+
+    # Members per page.
+    attr_accessor :page_size
+
+    # For a segment, true while it is being rebuilt, so the members are from the last rebuild.
+    attr_accessor :rebuild_required
+
+    # The segment, for a segment's members.
+    attr_accessor :segment_uuid
+
+    # How many members there are.
+    attr_accessor :total_members
+
+    # How many pages there are.
+    attr_accessor :total_pages
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'customer_data' => :'customer_data',
+        :'list_uuid' => :'list_uuid',
+        :'members' => :'members',
+        :'notes' => :'notes',
+        :'page' => :'page',
+        :'page_size' => :'page_size',
+        :'rebuild_required' => :'rebuild_required',
+        :'segment_uuid' => :'segment_uuid',
+        :'total_members' => :'total_members',
+        :'total_pages' => :'total_pages'
+      }
+    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
+      {
+        :'customer_data' => :'String',
+        :'list_uuid' => :'String',
+        :'members' => :'Array<SfvbCommsMember>',
+        :'notes' => :'Array<String>',
+        :'page' => :'Integer',
+        :'page_size' => :'Integer',
+        :'rebuild_required' => :'Boolean',
+        :'segment_uuid' => :'String',
+        :'total_members' => :'Integer',
+        :'total_pages' => :'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::SfvbCommsMembersResponse` 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::SfvbCommsMembersResponse`. 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?(:'customer_data')
+        self.customer_data = attributes[:'customer_data']
+      end
+
+      if attributes.key?(:'list_uuid')
+        self.list_uuid = attributes[:'list_uuid']
+      end
+
+      if attributes.key?(:'members')
+        if (value = attributes[:'members']).is_a?(Array)
+          self.members = value
+        end
+      end
+
+      if attributes.key?(:'notes')
+        if (value = attributes[:'notes']).is_a?(Array)
+          self.notes = 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?(:'rebuild_required')
+        self.rebuild_required = attributes[:'rebuild_required']
+      end
+
+      if attributes.key?(:'segment_uuid')
+        self.segment_uuid = attributes[:'segment_uuid']
+      end
+
+      if attributes.key?(:'total_members')
+        self.total_members = attributes[:'total_members']
+      end
+
+      if attributes.key?(:'total_pages')
+        self.total_pages = attributes[:'total_pages']
+      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 &&
+          customer_data == o.customer_data &&
+          list_uuid == o.list_uuid &&
+          members == o.members &&
+          notes == o.notes &&
+          page == o.page &&
+          page_size == o.page_size &&
+          rebuild_required == o.rebuild_required &&
+          segment_uuid == o.segment_uuid &&
+          total_members == o.total_members &&
+          total_pages == o.total_pages
+    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
+      [customer_data, list_uuid, members, notes, page, page_size, rebuild_required, segment_uuid, total_members, total_pages].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.rb

@@ -69,6 +69,9 @@ module UltracartClient
     # The part of the from address before the at sign.  Defaults to the storefront's marketing setting.
     attr_accessor :sending_user
 
+    # The number this flow's SMS steps send from.  Without one, every SMS step skips every customer, whatever the account's SMS settings say.
+    attr_accessor :sms_phone_number
+
     # The status, such as draft, active, paused, draining or inactive.
     attr_accessor :status
 
@@ -105,6 +108,7 @@ module UltracartClient
         :'sending_domain_uuid' => :'sending_domain_uuid',
         :'sending_name' => :'sending_name',
         :'sending_user' => :'sending_user',
+        :'sms_phone_number' => :'sms_phone_number',
         :'status' => :'status',
         :'status_dts' => :'status_dts',
         :'trigger_parameter' => :'trigger_parameter',
@@ -139,6 +143,7 @@ module UltracartClient
         :'sending_domain_uuid' => :'String',
         :'sending_name' => :'String',
         :'sending_user' => :'String',
+        :'sms_phone_number' => :'String',
         :'status' => :'String',
         :'status_dts' => :'String',
         :'trigger_parameter' => :'String',
@@ -246,6 +251,10 @@ module UltracartClient
         self.sending_user = attributes[:'sending_user']
       end
 
+      if attributes.key?(:'sms_phone_number')
+        self.sms_phone_number = attributes[:'sms_phone_number']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -303,6 +312,7 @@ module UltracartClient
           sending_domain_uuid == o.sending_domain_uuid &&
           sending_name == o.sending_name &&
           sending_user == o.sending_user &&
+          sms_phone_number == o.sms_phone_number &&
           status == o.status &&
           status_dts == o.status_dts &&
           trigger_parameter == o.trigger_parameter &&
@@ -319,7 +329,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [allow_multiple_concurrent_enrollments, communication_sequence_uuid, created_dts, deleted, emails, end_once_customer_purchases, end_once_customer_purchases_anywhere, flow_uuid, hash_sha256, live, name, notes, postcards, reentry_delay_days, reentry_policy, sending_domain_uuid, sending_name, sending_user, status, status_dts, trigger_parameter, trigger_parameter_name, trigger_type].hash
+      [allow_multiple_concurrent_enrollments, communication_sequence_uuid, created_dts, deleted, emails, end_once_customer_purchases, end_once_customer_purchases_anywhere, flow_uuid, hash_sha256, live, name, notes, postcards, reentry_delay_days, reentry_policy, sending_domain_uuid, sending_name, sending_user, sms_phone_number, status, status_dts, trigger_parameter, trigger_parameter_name, trigger_type].hash
     end
 
     # Builds the object from hash

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