Class: UltracartClient::ConversationPbxClassOfService

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/conversation_pbx_class_of_service.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationPbxClassOfService

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
134
135
136
137
138
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 88

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ConversationPbxClassOfService` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ConversationPbxClassOfService`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'block_premium_numbers')
    self.block_premium_numbers = attributes[:'block_premium_numbers']
  end

  if attributes.key?(:'conversation_pbx_class_of_service_uuid')
    self.conversation_pbx_class_of_service_uuid = attributes[:'conversation_pbx_class_of_service_uuid']
  end

  if attributes.key?(:'default_flag')
    self.default_flag = attributes[:'default_flag']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'merchant_id')
    self.merchant_id = attributes[:'merchant_id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'outbound_enabled')
    self.outbound_enabled = attributes[:'outbound_enabled']
  end

  if attributes.key?(:'time_range_uuid')
    self.time_range_uuid = attributes[:'time_range_uuid']
  end
end

Instance Attribute Details

#allowed_countries ⇒ Object

E.164 country calling codes (e.g. 1 for US/Canada, 44 for UK). Empty means domestic only.



19
20
21
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 19

def allowed_countries
  @allowed_countries
end

#block_premium_numbers ⇒ Object

Block calls to 900, 976, premium-rate, and shortcode destinations



22
23
24
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 22

def block_premium_numbers
  @block_premium_numbers
end

#conversation_pbx_class_of_service_uuid ⇒ Object

Class of Service unique identifier



25
26
27
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 25

def conversation_pbx_class_of_service_uuid
  @conversation_pbx_class_of_service_uuid
end

#default_flag ⇒ Object

If true, this CoS applies to all agents without an explicit cos_uuid. Only one per merchant.



28
29
30
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 28

def default_flag
  @default_flag
end

#description ⇒ Object

Description of the class of service



31
32
33
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 31

def description
  @description
end

#merchant_id ⇒ Object

Merchant Id



34
35
36
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 34

def merchant_id
  @merchant_id
end

#name ⇒ Object

Display name for the class of service



37
38
39
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 37

def name
  @name
end

#outbound_enabled ⇒ Object

Whether agents with this CoS can make outbound calls



40
41
42
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 40

def outbound_enabled
  @outbound_enabled
end

#time_range_uuid ⇒ Object

UUID of a time range. If set, outbound calls only permitted during those time windows.



43
44
45
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 43

def time_range_uuid
  @time_range_uuid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 46

def self.attribute_map
  {
    :'allowed_countries' => :'allowed_countries',
    :'block_premium_numbers' => :'block_premium_numbers',
    :'conversation_pbx_class_of_service_uuid' => :'conversation_pbx_class_of_service_uuid',
    :'default_flag' => :'default_flag',
    :'description' => :'description',
    :'merchant_id' => :'merchant_id',
    :'name' => :'name',
    :'outbound_enabled' => :'outbound_enabled',
    :'time_range_uuid' => :'time_range_uuid'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



229
230
231
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 229

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 81

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 66

def self.openapi_types
  {
    :'allowed_countries' => :'Array<String>',
    :'block_premium_numbers' => :'Boolean',
    :'conversation_pbx_class_of_service_uuid' => :'String',
    :'default_flag' => :'Boolean',
    :'description' => :'String',
    :'merchant_id' => :'String',
    :'name' => :'String',
    :'outbound_enabled' => :'Boolean',
    :'time_range_uuid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allowed_countries == o.allowed_countries &&
      block_premium_numbers == o.block_premium_numbers &&
      conversation_pbx_class_of_service_uuid == o.conversation_pbx_class_of_service_uuid &&
      default_flag == o.default_flag &&
      description == o.description &&
      merchant_id == o.merchant_id &&
      name == o.name &&
      outbound_enabled == o.outbound_enabled &&
      time_range_uuid == o.time_range_uuid
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 260

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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 =~ /\A(true|t|yes|y|1)\z/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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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

Parameters:

  • Any valid value

Returns:

  • Returns the value in the form of hash



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 331

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

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 236

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method

Parameters:

  • to be compared

Returns:



216
217
218
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



222
223
224
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 222

def hash
  [allowed_countries, block_premium_numbers, conversation_pbx_class_of_service_uuid, default_flag, description, merchant_id, name, outbound_enabled, time_range_uuid].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 142

def list_invalid_properties
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 500
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 500.')
  end

  if !@merchant_id.nil? && @merchant_id.to_s.length > 5
    invalid_properties.push('invalid value for "merchant_id", the character length must be smaller than or equal to 5.')
  end

  if !@name.nil? && @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



307
308
309
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 307

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 313

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • String presentation of the object



301
302
303
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 301

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



161
162
163
164
165
166
 
# File 'lib/ultracart_api/models/conversation_pbx_class_of_service.rb', line 161

def valid?
  return false if !@description.nil? && @description.to_s.length > 500
  return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
  return false if !@name.nil? && @name.to_s.length > 100
  true
end