class UltracartClient::EmailFlow
Attributes
True if a customer may be enrolled in this flow multiple times
True if the flow is currently performing a back population.
Click rate of emails, formatted
Created date
True if this campaign was deleted
Email communication sequence UUID
Email flow UUID
True if the customer should end the flow once they purchase from an email on this flow
True if the customer should end the flow once they purchase from any source
Number of enrolled customers.
Username of sending email
UUID of sending domain
Flow folder UUID. Null for uncategorized
Friendly name of the sending email
File profile equation json
If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.
Merchant ID
Name of email flow
Open rate of emails, formatted
Revenue, formatted
Revenue per customer, formatted
URL to a large full length screenshot
Status of the campaign of draft, archived, active, and inactive
Timestamp when the last status change happened
Storefront oid
Trigger parameter
Trigger parameter name
Trigger type
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ultracart_api/models/email_flow.rb, line 102 def self.attribute_map { :'allow_multiple_concurrent_enrollments' => :'allow_multiple_concurrent_enrollments', :'back_populating' => :'back_populating', :'click_rate_formatted' => :'click_rate_formatted', :'created_dts' => :'created_dts', :'deleted' => :'deleted', :'email_communication_sequence_uuid' => :'email_communication_sequence_uuid', :'email_flow_uuid' => :'email_flow_uuid', :'end_once_customer_purchases' => :'end_once_customer_purchases', :'end_once_customer_purchases_anywhere' => :'end_once_customer_purchases_anywhere', :'enrolled_customers' => :'enrolled_customers', :'esp_domain_user' => :'esp_domain_user', :'esp_domain_uuid' => :'esp_domain_uuid', :'esp_flow_folder_uuid' => :'esp_flow_folder_uuid', :'esp_friendly_name' => :'esp_friendly_name', :'filter_profile_equation_json' => :'filter_profile_equation_json', :'library_item_oid' => :'library_item_oid', :'merchant_id' => :'merchant_id', :'name' => :'name', :'open_rate_formatted' => :'open_rate_formatted', :'revenue_formatted' => :'revenue_formatted', :'revenue_per_customer_formatted' => :'revenue_per_customer_formatted', :'screenshot_large_full_url' => :'screenshot_large_full_url', :'status' => :'status', :'status_dts' => :'status_dts', :'storefront_oid' => :'storefront_oid', :'trigger_parameter' => :'trigger_parameter', :'trigger_parameter_name' => :'trigger_parameter_name', :'trigger_type' => :'trigger_type' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ultracart_api/models/email_flow.rb, line 171 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'allow_multiple_concurrent_enrollments') self.allow_multiple_concurrent_enrollments = attributes[:'allow_multiple_concurrent_enrollments'] end if attributes.has_key?(:'back_populating') self.back_populating = attributes[:'back_populating'] end if attributes.has_key?(:'click_rate_formatted') self.click_rate_formatted = attributes[:'click_rate_formatted'] end if attributes.has_key?(:'created_dts') self.created_dts = attributes[:'created_dts'] end if attributes.has_key?(:'deleted') self.deleted = attributes[:'deleted'] end if attributes.has_key?(:'email_communication_sequence_uuid') self.email_communication_sequence_uuid = attributes[:'email_communication_sequence_uuid'] end if attributes.has_key?(:'email_flow_uuid') self.email_flow_uuid = attributes[:'email_flow_uuid'] end if attributes.has_key?(:'end_once_customer_purchases') self.end_once_customer_purchases = attributes[:'end_once_customer_purchases'] end if attributes.has_key?(:'end_once_customer_purchases_anywhere') self.end_once_customer_purchases_anywhere = attributes[:'end_once_customer_purchases_anywhere'] end if attributes.has_key?(:'enrolled_customers') self.enrolled_customers = attributes[:'enrolled_customers'] end if attributes.has_key?(:'esp_domain_user') self.esp_domain_user = attributes[:'esp_domain_user'] end if attributes.has_key?(:'esp_domain_uuid') self.esp_domain_uuid = attributes[:'esp_domain_uuid'] end if attributes.has_key?(:'esp_flow_folder_uuid') self.esp_flow_folder_uuid = attributes[:'esp_flow_folder_uuid'] end if attributes.has_key?(:'esp_friendly_name') self.esp_friendly_name = attributes[:'esp_friendly_name'] end if attributes.has_key?(:'filter_profile_equation_json') self.filter_profile_equation_json = attributes[:'filter_profile_equation_json'] end if attributes.has_key?(:'library_item_oid') self.library_item_oid = attributes[:'library_item_oid'] end if attributes.has_key?(:'merchant_id') self.merchant_id = attributes[:'merchant_id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'open_rate_formatted') self.open_rate_formatted = attributes[:'open_rate_formatted'] end if attributes.has_key?(:'revenue_formatted') self.revenue_formatted = attributes[:'revenue_formatted'] end if attributes.has_key?(:'revenue_per_customer_formatted') self.revenue_per_customer_formatted = attributes[:'revenue_per_customer_formatted'] end if attributes.has_key?(:'screenshot_large_full_url') self.screenshot_large_full_url = attributes[:'screenshot_large_full_url'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'status_dts') self.status_dts = attributes[:'status_dts'] end if attributes.has_key?(:'storefront_oid') self.storefront_oid = attributes[:'storefront_oid'] end if attributes.has_key?(:'trigger_parameter') self.trigger_parameter = attributes[:'trigger_parameter'] end if attributes.has_key?(:'trigger_parameter_name') self.trigger_parameter_name = attributes[:'trigger_parameter_name'] end if attributes.has_key?(:'trigger_type') self.trigger_type = attributes[:'trigger_type'] end end
Attribute type mapping.
# File lib/ultracart_api/models/email_flow.rb, line 136 def self.swagger_types { :'allow_multiple_concurrent_enrollments' => :'BOOLEAN', :'back_populating' => :'BOOLEAN', :'click_rate_formatted' => :'String', :'created_dts' => :'String', :'deleted' => :'BOOLEAN', :'email_communication_sequence_uuid' => :'String', :'email_flow_uuid' => :'String', :'end_once_customer_purchases' => :'BOOLEAN', :'end_once_customer_purchases_anywhere' => :'BOOLEAN', :'enrolled_customers' => :'Integer', :'esp_domain_user' => :'String', :'esp_domain_uuid' => :'String', :'esp_flow_folder_uuid' => :'String', :'esp_friendly_name' => :'String', :'filter_profile_equation_json' => :'String', :'library_item_oid' => :'Integer', :'merchant_id' => :'String', :'name' => :'String', :'open_rate_formatted' => :'String', :'revenue_formatted' => :'String', :'revenue_per_customer_formatted' => :'String', :'screenshot_large_full_url' => :'String', :'status' => :'String', :'status_dts' => :'String', :'storefront_oid' => :'Integer', :'trigger_parameter' => :'String', :'trigger_parameter_name' => :'String', :'trigger_type' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ultracart_api/models/email_flow.rb, line 320 def ==(o) return true if self.equal?(o) self.class == o.class && allow_multiple_concurrent_enrollments == o.allow_multiple_concurrent_enrollments && back_populating == o.back_populating && click_rate_formatted == o.click_rate_formatted && created_dts == o.created_dts && deleted == o.deleted && email_communication_sequence_uuid == o.email_communication_sequence_uuid && email_flow_uuid == o.email_flow_uuid && end_once_customer_purchases == o.end_once_customer_purchases && end_once_customer_purchases_anywhere == o.end_once_customer_purchases_anywhere && enrolled_customers == o.enrolled_customers && esp_domain_user == o.esp_domain_user && esp_domain_uuid == o.esp_domain_uuid && esp_flow_folder_uuid == o.esp_flow_folder_uuid && esp_friendly_name == o.esp_friendly_name && filter_profile_equation_json == o.filter_profile_equation_json && library_item_oid == o.library_item_oid && merchant_id == o.merchant_id && name == o.name && open_rate_formatted == o.open_rate_formatted && revenue_formatted == o.revenue_formatted && revenue_per_customer_formatted == o.revenue_per_customer_formatted && screenshot_large_full_url == o.screenshot_large_full_url && status == o.status && status_dts == o.status_dts && storefront_oid == o.storefront_oid && trigger_parameter == o.trigger_parameter && trigger_parameter_name == o.trigger_parameter_name && trigger_type == o.trigger_type end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/ultracart_api/models/email_flow.rb, line 389 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 temp_model = UltracartClient.const_get(type).new temp_model.build_from_hash(value) end 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
# File lib/ultracart_api/models/email_flow.rb, line 455 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ultracart_api/models/email_flow.rb, line 368 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if 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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/ultracart_api/models/email_flow.rb, line 355 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/ultracart_api/models/email_flow.rb, line 361 def hash [allow_multiple_concurrent_enrollments, back_populating, click_rate_formatted, created_dts, deleted, email_communication_sequence_uuid, email_flow_uuid, end_once_customer_purchases, end_once_customer_purchases_anywhere, enrolled_customers, esp_domain_user, esp_domain_uuid, esp_flow_folder_uuid, esp_friendly_name, filter_profile_equation_json, library_item_oid, merchant_id, name, open_rate_formatted, revenue_formatted, revenue_per_customer_formatted, screenshot_large_full_url, status, status_dts, storefront_oid, trigger_parameter, trigger_parameter_name, trigger_type].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ultracart_api/models/email_flow.rb, line 292 def list_invalid_properties invalid_properties = Array.new if !@name.nil? && @name.to_s.length > 250 invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 250.') end invalid_properties end
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/ultracart_api/models/email_flow.rb, line 310 def name=(name) if !name.nil? && name.to_s.length > 250 fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 250.' end @name = name end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ultracart_api/models/email_flow.rb, line 441 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ultracart_api/models/email_flow.rb, line 429 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/ultracart_api/models/email_flow.rb, line 303 def valid? return false if !@name.nil? && @name.to_s.length > 250 true end