Class: PureCloud::AvailableAdditionalService

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AvailableAdditionalService



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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'lib/purecloud/models/available_additional_service.rb', line 78

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[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'partNumber']
    self.part_number = attributes[:'partNumber']
  end
  
  if attributes[:'requiredForProducts']
    if (value = attributes[:'requiredForProducts']).is_a?(Array)
      self.required_for_products = value
    end
  end
  
  if attributes[:'availableForProducts']
    if (value = attributes[:'availableForProducts']).is_a?(Array)
      self.available_for_products = value
    end
  end
  
  if attributes[:'defaultForProducts']
    if (value = attributes[:'defaultForProducts']).is_a?(Array)
      self.default_for_products = value
    end
  end
  
  if attributes[:'exclusiveFromProducts']
    if (value = attributes[:'exclusiveFromProducts']).is_a?(Array)
      self.exclusive_from_products = value
    end
  end
  
  if attributes[:'rate']
    self.rate = attributes[:'rate']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#available_for_productsObject

The list of products for which this additional service is available.



20
21
22
# File 'lib/purecloud/models/available_additional_service.rb', line 20

def available_for_products
  @available_for_products
end

#default_for_productsObject

The list of products which have this additional service by default.



23
24
25
# File 'lib/purecloud/models/available_additional_service.rb', line 23

def default_for_products
  @default_for_products
end

#descriptionObject

The description of this additional service.



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

def description
  @description
end

#exclusive_from_productsObject

The list of additional services which are not compatible with this additional service.



26
27
28
# File 'lib/purecloud/models/available_additional_service.rb', line 26

def exclusive_from_products
  @exclusive_from_products
end

#idObject

The globally unique identifier for the object.



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

def id
  @id
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#part_numberObject

The part number of this additional service.



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

def part_number
  @part_number
end

#rateObject

The rate of this additional service.



29
30
31
# File 'lib/purecloud/models/available_additional_service.rb', line 29

def rate
  @rate
end

#required_for_productsObject

The list of products which require this additional service.



17
18
19
# File 'lib/purecloud/models/available_additional_service.rb', line 17

def required_for_products
  @required_for_products
end

#self_uriObject

The URI for this object



32
33
34
# File 'lib/purecloud/models/available_additional_service.rb', line 32

def self_uri
  @self_uri
end

Class Method Details

.attribute_mapObject

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



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/purecloud/models/available_additional_service.rb', line 35

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'part_number' => :'partNumber',
    
    :'required_for_products' => :'requiredForProducts',
    
    :'available_for_products' => :'availableForProducts',
    
    :'default_for_products' => :'defaultForProducts',
    
    :'exclusive_from_products' => :'exclusiveFromProducts',
    
    :'rate' => :'rate',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/purecloud/models/available_additional_service.rb', line 62

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'part_number' => :'String',
    :'required_for_products' => :'Array<String>',
    :'available_for_products' => :'Array<String>',
    :'default_for_products' => :'Array<String>',
    :'exclusive_from_products' => :'Array<String>',
    :'rate' => :'Rate',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/purecloud/models/available_additional_service.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      part_number == o.part_number &&
      required_for_products == o.required_for_products &&
      available_for_products == o.available_for_products &&
      default_for_products == o.default_for_products &&
      exclusive_from_products == o.exclusive_from_products &&
      rate == o.rate &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/purecloud/models/available_additional_service.rb', line 181

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



238
239
240
241
242
243
244
245
246
247
248
249
250
# File 'lib/purecloud/models/available_additional_service.rb', line 238

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'lib/purecloud/models/available_additional_service.rb', line 162

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


152
153
154
# File 'lib/purecloud/models/available_additional_service.rb', line 152

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



157
158
159
# File 'lib/purecloud/models/available_additional_service.rb', line 157

def hash
  [id, name, description, part_number, required_for_products, available_for_products, default_for_products, exclusive_from_products, rate, self_uri].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



221
222
223
# File 'lib/purecloud/models/available_additional_service.rb', line 221

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



226
227
228
229
230
231
232
233
234
# File 'lib/purecloud/models/available_additional_service.rb', line 226

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



216
217
218
# File 'lib/purecloud/models/available_additional_service.rb', line 216

def to_s
  to_hash.to_s
end