Class: PureCloud::FlowTerminateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/flow_terminate_request.rb

Overview

Passed into a terminate command to customize the termination action.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlowTerminateRequest 



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 26

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'reason']
    self.reason = attributes[:'reason']
  end
  
end

Instance Attribute Details

#reason ⇒ Object

Reason code for a termination.



7
8
9
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 7

def reason
  @reason
end

Class Method Details

.attribute_map ⇒ Object

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



10
11
12
13
14
15
16
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 10

def self.attribute_map
  {
    
    :'reason' => :'reason'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



19
20
21
22
23
24
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 19

def self.swagger_types
  {
    :'reason' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



40
41
42
43
44
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 40

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reason == o.reason
end

#_deserialize(type, value) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 76

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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) ⇒ Object

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



133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 133

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) ⇒ Object

build the object from hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 57

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


47
48
49
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 47

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



52
53
54
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 52

def hash
  [reason].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



116
117
118
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 116

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



121
122
123
124
125
126
127
128
129
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 121

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 ⇒ Object 



111
112
113
 
# File 'lib/purecloud/models/flow_terminate_request.rb', line 111

def to_s
  to_hash.to_s
end