Class: PureCloud::CoverSheet

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CoverSheet

Returns a new instance of CoverSheet.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/purecloud/models/cover_sheet.rb', line 47

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[:'notes']
    self.notes = attributes[:'notes']
  end
  
  if attributes[:'locale']
    self.locale = attributes[:'locale']
  end
  
end

Instance Attribute Details

#localeObject

Locale, e.g. = en-US



25
26
27
# File 'lib/purecloud/models/cover_sheet.rb', line 25

def locale
  @locale
end

#notesObject

Text to be added to the coversheet



22
23
24
# File 'lib/purecloud/models/cover_sheet.rb', line 22

def notes
  @notes
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    
    :'notes' => :'notes',
    
    :'locale' => :'locale'
    
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    :'notes' => :'String',
    :'locale' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



65
66
67
68
69
70
# File 'lib/purecloud/models/cover_sheet.rb', line 65

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

#_deserialize(type, value) ⇒ Object



102
103
104
105
106
107
108
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
# File 'lib/purecloud/models/cover_sheet.rb', line 102

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

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



162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/purecloud/models/cover_sheet.rb', line 162

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/purecloud/models/cover_sheet.rb', line 83

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


73
74
75
# File 'lib/purecloud/models/cover_sheet.rb', line 73

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



78
79
80
# File 'lib/purecloud/models/cover_sheet.rb', line 78

def hash
  [notes, locale].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



145
146
147
# File 'lib/purecloud/models/cover_sheet.rb', line 145

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



150
151
152
153
154
155
156
157
158
# File 'lib/purecloud/models/cover_sheet.rb', line 150

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_sObject



140
141
142
# File 'lib/purecloud/models/cover_sheet.rb', line 140

def to_s
  to_hash.to_s
end