ultracart_api 4.1.232 → 4.1.234

data/lib/ultracart_api/models/sfvb_comms_unreferenced_response.rb

@@ -0,0 +1,296 @@
+=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 SfvbCommsUnreferencedResponse
+    # How many emails no step names.
+    attr_accessor :email_count
+
+    # Emails no step names, most recently changed first.
+    attr_accessor :emails
+
+    # How many emails the storefront has.
+    attr_accessor :emails_checked
+
+    # What the report means, in sentences.
+    attr_accessor :notes
+
+    # How many postcards no step names.
+    attr_accessor :postcard_count
+
+    # Postcards no step names, most recently changed first.
+    attr_accessor :postcards
+
+    # How many postcards the storefront has.
+    attr_accessor :postcards_checked
+
+    # How many sequences were read for the steps that name them.
+    attr_accessor :sequences_checked
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email_count' => :'email_count',
+        :'emails' => :'emails',
+        :'emails_checked' => :'emails_checked',
+        :'notes' => :'notes',
+        :'postcard_count' => :'postcard_count',
+        :'postcards' => :'postcards',
+        :'postcards_checked' => :'postcards_checked',
+        :'sequences_checked' => :'sequences_checked'
+      }
+    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
+      {
+        :'email_count' => :'Integer',
+        :'emails' => :'Array<SfvbCommsUnreferencedEmail>',
+        :'emails_checked' => :'Integer',
+        :'notes' => :'Array<String>',
+        :'postcard_count' => :'Integer',
+        :'postcards' => :'Array<SfvbCommsUnreferencedPostcard>',
+        :'postcards_checked' => :'Integer',
+        :'sequences_checked' => :'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::SfvbCommsUnreferencedResponse` 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::SfvbCommsUnreferencedResponse`. 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?(:'email_count')
+        self.email_count = attributes[:'email_count']
+      end
+
+      if attributes.key?(:'emails')
+        if (value = attributes[:'emails']).is_a?(Array)
+          self.emails = value
+        end
+      end
+
+      if attributes.key?(:'emails_checked')
+        self.emails_checked = attributes[:'emails_checked']
+      end
+
+      if attributes.key?(:'notes')
+        if (value = attributes[:'notes']).is_a?(Array)
+          self.notes = value
+        end
+      end
+
+      if attributes.key?(:'postcard_count')
+        self.postcard_count = attributes[:'postcard_count']
+      end
+
+      if attributes.key?(:'postcards')
+        if (value = attributes[:'postcards']).is_a?(Array)
+          self.postcards = value
+        end
+      end
+
+      if attributes.key?(:'postcards_checked')
+        self.postcards_checked = attributes[:'postcards_checked']
+      end
+
+      if attributes.key?(:'sequences_checked')
+        self.sequences_checked = attributes[:'sequences_checked']
+      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 &&
+          email_count == o.email_count &&
+          emails == o.emails &&
+          emails_checked == o.emails_checked &&
+          notes == o.notes &&
+          postcard_count == o.postcard_count &&
+          postcards == o.postcards &&
+          postcards_checked == o.postcards_checked &&
+          sequences_checked == o.sequences_checked
+    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
+      [email_count, emails, emails_checked, notes, postcard_count, postcards, postcards_checked, sequences_checked].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_email.rb

@@ -18,6 +18,9 @@ module UltracartClient
     # When the email container was last changed (ISO 8601, UTC).
     attr_accessor :container_last_modified_dts
 
+    # The Velocity template the email body renders inside, as stored, such as templates/template_email.vm.  It is looked up in the storefront's active theme.
+    attr_accessor :email_template_vm_path
+
     # The email uuid.  The same uuid the email container (owner type email) and the email render take.
     attr_accessor :email_uuid
 
@@ -48,6 +51,15 @@ module UltracartClient
     # True when UltraCart suspended the email for spam.  Edits are refused until the merchant resolves it with UltraCart support.
     attr_accessor :suspended_for_spam
 
+    # True when the file at template_path exists.  False means the email can't render.
+    attr_accessor :template_exists
+
+    # Why there is no template file, or null when there is one.
+    attr_accessor :template_note
+
+    # The theme file that template is, as the render finds it.  Read it with the files endpoints, whose read also reports valid and velocity_errors.  Null when it couldn't be worked out, with template_note saying why.
+    attr_accessor :template_path
+
     # True for a transactional email, which skips the marketing footer rules.
     attr_accessor :transactional
 
@@ -58,6 +70,7 @@ module UltracartClient
     def self.attribute_map
       {
         :'container_last_modified_dts' => :'container_last_modified_dts',
+        :'email_template_vm_path' => :'email_template_vm_path',
         :'email_uuid' => :'email_uuid',
         :'hash_sha256' => :'hash_sha256',
         :'live' => :'live',
@@ -68,6 +81,9 @@ module UltracartClient
         :'requires_review' => :'requires_review',
         :'subject' => :'subject',
         :'suspended_for_spam' => :'suspended_for_spam',
+        :'template_exists' => :'template_exists',
+        :'template_note' => :'template_note',
+        :'template_path' => :'template_path',
         :'transactional' => :'transactional',
         :'version' => :'version'
       }
@@ -82,6 +98,7 @@ module UltracartClient
     def self.openapi_types
       {
         :'container_last_modified_dts' => :'String',
+        :'email_template_vm_path' => :'String',
         :'email_uuid' => :'String',
         :'hash_sha256' => :'String',
         :'live' => :'Boolean',
@@ -92,6 +109,9 @@ module UltracartClient
         :'requires_review' => :'Boolean',
         :'subject' => :'String',
         :'suspended_for_spam' => :'Boolean',
+        :'template_exists' => :'Boolean',
+        :'template_note' => :'String',
+        :'template_path' => :'String',
         :'transactional' => :'Boolean',
         :'version' => :'Integer'
       }
@@ -122,6 +142,10 @@ module UltracartClient
         self.container_last_modified_dts = attributes[:'container_last_modified_dts']
       end
 
+      if attributes.key?(:'email_template_vm_path')
+        self.email_template_vm_path = attributes[:'email_template_vm_path']
+      end
+
       if attributes.key?(:'email_uuid')
         self.email_uuid = attributes[:'email_uuid']
       end
@@ -164,6 +188,18 @@ module UltracartClient
         self.suspended_for_spam = attributes[:'suspended_for_spam']
       end
 
+      if attributes.key?(:'template_exists')
+        self.template_exists = attributes[:'template_exists']
+      end
+
+      if attributes.key?(:'template_note')
+        self.template_note = attributes[:'template_note']
+      end
+
+      if attributes.key?(:'template_path')
+        self.template_path = attributes[:'template_path']
+      end
+
       if attributes.key?(:'transactional')
         self.transactional = attributes[:'transactional']
       end
@@ -192,6 +228,7 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           container_last_modified_dts == o.container_last_modified_dts &&
+          email_template_vm_path == o.email_template_vm_path &&
           email_uuid == o.email_uuid &&
           hash_sha256 == o.hash_sha256 &&
           live == o.live &&
@@ -202,6 +239,9 @@ module UltracartClient
           requires_review == o.requires_review &&
           subject == o.subject &&
           suspended_for_spam == o.suspended_for_spam &&
+          template_exists == o.template_exists &&
+          template_note == o.template_note &&
+          template_path == o.template_path &&
           transactional == o.transactional &&
           version == o.version
     end
@@ -215,7 +255,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [container_last_modified_dts, email_uuid, hash_sha256, live, notes, pending_review, preview_text, rejected, requires_review, subject, suspended_for_spam, transactional, version].hash
+      [container_last_modified_dts, email_template_vm_path, email_uuid, hash_sha256, live, notes, pending_review, preview_text, rejected, requires_review, subject, suspended_for_spam, template_exists, template_note, template_path, transactional, version].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_flow.rb

@@ -39,6 +39,12 @@ module UltracartClient
     # The flow uuid.
     attr_accessor :flow_uuid
 
+    # That folder's name.
+    attr_accessor :folder_name
+
+    # The flow folder it is filed in, or none.
+    attr_accessor :folder_uuid
+
     # Send this as If-Match when changing, archiving or turning the flow on or off.
     attr_accessor :hash_sha256
 
@@ -98,6 +104,8 @@ module UltracartClient
         :'end_once_customer_purchases' => :'end_once_customer_purchases',
         :'end_once_customer_purchases_anywhere' => :'end_once_customer_purchases_anywhere',
         :'flow_uuid' => :'flow_uuid',
+        :'folder_name' => :'folder_name',
+        :'folder_uuid' => :'folder_uuid',
         :'hash_sha256' => :'hash_sha256',
         :'live' => :'live',
         :'name' => :'name',
@@ -133,6 +141,8 @@ module UltracartClient
         :'end_once_customer_purchases' => :'Boolean',
         :'end_once_customer_purchases_anywhere' => :'Boolean',
         :'flow_uuid' => :'String',
+        :'folder_name' => :'String',
+        :'folder_uuid' => :'String',
         :'hash_sha256' => :'String',
         :'live' => :'Boolean',
         :'name' => :'String',
@@ -207,6 +217,14 @@ module UltracartClient
         self.flow_uuid = attributes[:'flow_uuid']
       end
 
+      if attributes.key?(:'folder_name')
+        self.folder_name = attributes[:'folder_name']
+      end
+
+      if attributes.key?(:'folder_uuid')
+        self.folder_uuid = attributes[:'folder_uuid']
+      end
+
       if attributes.key?(:'hash_sha256')
         self.hash_sha256 = attributes[:'hash_sha256']
       end
@@ -302,6 +320,8 @@ module UltracartClient
           end_once_customer_purchases == o.end_once_customer_purchases &&
           end_once_customer_purchases_anywhere == o.end_once_customer_purchases_anywhere &&
           flow_uuid == o.flow_uuid &&
+          folder_name == o.folder_name &&
+          folder_uuid == o.folder_uuid &&
           hash_sha256 == o.hash_sha256 &&
           live == o.live &&
           name == o.name &&
@@ -329,7 +349,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, sms_phone_number, 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, folder_name, folder_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