class PureCloud::AnalyticsFlow

Attributes

ending_language[RW]

Flow ending language, e.g. en-us

entry_reason[RW]

The particular entry reason for this flow, e.g. an address, userId, or flowId

entry_type[RW]

The entry type for this flow

exit_reason[RW]

The exit reason for this flow, e.g. DISCONNECT

flow_id[RW]

The unique identifier of this flow

flow_name[RW]

The name of this flow

flow_type[RW]

The type of this flow

flow_version[RW]

The version of this flow

issued_callback[RW]

Flag indicating whether the flow issued a callback

outcomes[RW]

Flow outcomes

starting_language[RW]

Flow starting language, e.g. en-us

transfer_target_address[RW]

The address of a transfer target

transfer_target_name[RW]

The name of a transfer target

transfer_type[RW]

The type of transfer for flows that ended with a transfer

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 64
def self.attribute_map
  {
    
    :'flow_id' => :'flowId',
    
    :'flow_name' => :'flowName',
    
    :'flow_version' => :'flowVersion',
    
    :'flow_type' => :'flowType',
    
    :'exit_reason' => :'exitReason',
    
    :'entry_reason' => :'entryReason',
    
    :'entry_type' => :'entryType',
    
    :'transfer_type' => :'transferType',
    
    :'transfer_target_name' => :'transferTargetName',
    
    :'transfer_target_address' => :'transferTargetAddress',
    
    :'issued_callback' => :'issuedCallback',
    
    :'starting_language' => :'startingLanguage',
    
    :'ending_language' => :'endingLanguage',
    
    :'outcomes' => :'outcomes'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 135
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?(:'flowId')
    
    
    self.flow_id = attributes[:'flowId']
    
  
  end

  
  if attributes.has_key?(:'flowName')
    
    
    self.flow_name = attributes[:'flowName']
    
  
  end

  
  if attributes.has_key?(:'flowVersion')
    
    
    self.flow_version = attributes[:'flowVersion']
    
  
  end

  
  if attributes.has_key?(:'flowType')
    
    
    self.flow_type = attributes[:'flowType']
    
  
  end

  
  if attributes.has_key?(:'exitReason')
    
    
    self.exit_reason = attributes[:'exitReason']
    
  
  end

  
  if attributes.has_key?(:'entryReason')
    
    
    self.entry_reason = attributes[:'entryReason']
    
  
  end

  
  if attributes.has_key?(:'entryType')
    
    
    self.entry_type = attributes[:'entryType']
    
  
  end

  
  if attributes.has_key?(:'transferType')
    
    
    self.transfer_type = attributes[:'transferType']
    
  
  end

  
  if attributes.has_key?(:'transferTargetName')
    
    
    self.transfer_target_name = attributes[:'transferTargetName']
    
  
  end

  
  if attributes.has_key?(:'transferTargetAddress')
    
    
    self.transfer_target_address = attributes[:'transferTargetAddress']
    
  
  end

  
  if attributes.has_key?(:'issuedCallback')
    
    
    self.issued_callback = attributes[:'issuedCallback']
    
  
  end

  
  if attributes.has_key?(:'startingLanguage')
    
    
    self.starting_language = attributes[:'startingLanguage']
    
  
  end

  
  if attributes.has_key?(:'endingLanguage')
    
    
    self.ending_language = attributes[:'endingLanguage']
    
  
  end

  
  if attributes.has_key?(:'outcomes')
    
    if (value = attributes[:'outcomes']).is_a?(Array)
      self.outcomes = value
    end
    
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 99
def self.swagger_types
  {
    
    :'flow_id' => :'String',
    
    :'flow_name' => :'String',
    
    :'flow_version' => :'String',
    
    :'flow_type' => :'String',
    
    :'exit_reason' => :'String',
    
    :'entry_reason' => :'String',
    
    :'entry_type' => :'String',
    
    :'transfer_type' => :'String',
    
    :'transfer_target_name' => :'String',
    
    :'transfer_target_address' => :'String',
    
    :'issued_callback' => :'BOOLEAN',
    
    :'starting_language' => :'String',
    
    :'ending_language' => :'String',
    
    :'outcomes' => :'Array<AnalyticsFlowOutcome>'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 444
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      flow_id == o.flow_id &&
      flow_name == o.flow_name &&
      flow_version == o.flow_version &&
      flow_type == o.flow_type &&
      exit_reason == o.exit_reason &&
      entry_reason == o.entry_reason &&
      entry_type == o.entry_type &&
      transfer_type == o.transfer_type &&
      transfer_target_name == o.transfer_target_name &&
      transfer_target_address == o.transfer_target_address &&
      issued_callback == o.issued_callback &&
      starting_language == o.starting_language &&
      ending_language == o.ending_language &&
      outcomes == o.outcomes
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 495
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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 555
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
build_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 476
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end
entry_type=(entry_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] entry_type Object to be assigned

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 396
def entry_type=(entry_type)
  allowed_values = ["dnis", "direct", "flow", "agent", "outbound"]
  if entry_type && !allowed_values.include?(entry_type)
    fail ArgumentError, "invalid value for 'entry_type', must be one of #{allowed_values}."
  end
  @entry_type = entry_type
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 465
def eql?(o)
  self == o
end
flow_type=(flow_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] flow_type Object to be assigned

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 372
def flow_type=(flow_type)
  allowed_values = ["BOT", "COMMONMODULE", "INBOUNDCALL", "INBOUNDCHAT", "INBOUNDEMAIL", "INBOUNDSHORTMESSAGE", "INQUEUECALL", "OUTBOUNDCALL", "SECURECALL", "SPEECH", "SURVEYINVITE", "WORKFLOW"]
  if flow_type && !allowed_values.include?(flow_type)
    fail ArgumentError, "invalid value for 'flow_type', must be one of #{allowed_values}."
  end
  @flow_type = flow_type
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 471
def hash
  [flow_id, flow_name, flow_version, flow_type, exit_reason, entry_reason, entry_type, transfer_type, transfer_target_name, transfer_target_address, issued_callback, starting_language, ending_language, outcomes].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 274
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 538
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 543
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
to_s() click to toggle source
# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 533
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/analytics_flow.rb, line 283
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["BOT", "COMMONMODULE", "INBOUNDCALL", "INBOUNDCHAT", "INBOUNDEMAIL", "INBOUNDSHORTMESSAGE", "INQUEUECALL", "OUTBOUNDCALL", "SECURECALL", "SPEECH", "SURVEYINVITE", "WORKFLOW"]
  if @flow_type && !allowed_values.include?(@flow_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["dnis", "direct", "flow", "agent", "outbound"]
  if @entry_type && !allowed_values.include?(@entry_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end