Class: PureCloud::WorkItemDefinition

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkItemDefinition

Returns a new instance of WorkItemDefinition.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/purecloud/models/work_item_definition.rb', line 42

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[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'commandCategories']
    if (value = attributes[:'commandCategories']).is_a?(Array)
      self.command_categories = value
    end
  end
  
  if attributes[:'form']
    self.form = attributes[:'form']
  end
  
end

Instance Attribute Details

#command_categories ⇒ Object

The commands that can be performed on this work item



11
12
13
 
# File 'lib/purecloud/models/work_item_definition.rb', line 11

def command_categories
  @command_categories
end

#form ⇒ Object

The simple work item form containging the control to present for this work item



14
15
16
 
# File 'lib/purecloud/models/work_item_definition.rb', line 14

def form
  @form
end

#id ⇒ Object

The configuration ID for this workItem



6
7
8
 
# File 'lib/purecloud/models/work_item_definition.rb', line 6

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/work_item_definition.rb', line 8

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/purecloud/models/work_item_definition.rb', line 17

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'command_categories' => :'commandCategories',
    
    :'form' => :'form'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
38
39
40
 
# File 'lib/purecloud/models/work_item_definition.rb', line 32

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'command_categories' => :'Array<WorkItemCommandGroup>',
    :'form' => :'Form'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



70
71
72
73
74
75
76
77
 
# File 'lib/purecloud/models/work_item_definition.rb', line 70

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      command_categories == o.command_categories &&
      form == o.form
end

#_deserialize(type, value) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/purecloud/models/work_item_definition.rb', line 109

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



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/purecloud/models/work_item_definition.rb', line 166

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/purecloud/models/work_item_definition.rb', line 90

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

Returns:

  • (Boolean)

See Also:

  • `==` method


80
81
82
 
# File 'lib/purecloud/models/work_item_definition.rb', line 80

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



85
86
87
 
# File 'lib/purecloud/models/work_item_definition.rb', line 85

def hash
  [id, name, command_categories, form].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



149
150
151
 
# File 'lib/purecloud/models/work_item_definition.rb', line 149

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



154
155
156
157
158
159
160
161
162
 
# File 'lib/purecloud/models/work_item_definition.rb', line 154

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 



144
145
146
 
# File 'lib/purecloud/models/work_item_definition.rb', line 144

def to_s
  to_hash.to_s
end