Class: PureCloud::NumberOrderRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NumberOrderRequest

Returns a new instance of NumberOrderRequest.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/purecloud/models/number_order_request.rb', line 46

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[:'orderTns']
    if (value = attributes[:'orderTns']).is_a?(Array)
      self.order_tns = value
    end
  end
  
  if attributes[:'reservationIds']
    if (value = attributes[:'reservationIds']).is_a?(Array)
      self.reservation_ids = value
    end
  end
  
  if attributes[:'orderId']
    self.order_id = attributes[:'orderId']
  end
  
  if attributes[:'effectiveDate']
    self.effective_date = attributes[:'effectiveDate']
  end
  
  if attributes[:'phoneNumberType']
    self.phone_number_type = attributes[:'phoneNumberType']
  end
  
end

Instance Attribute Details

#effective_date ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



12
13
14
 
# File 'lib/purecloud/models/number_order_request.rb', line 12

def effective_date
  @effective_date
end

#order_id ⇒ Object

Returns the value of attribute order_id.



9
10
11
 
# File 'lib/purecloud/models/number_order_request.rb', line 9

def order_id
  @order_id
end

#order_tns ⇒ Object

Returns the value of attribute order_tns.



5
6
7
 
# File 'lib/purecloud/models/number_order_request.rb', line 5

def order_tns
  @order_tns
end

#phone_number_type ⇒ Object

The type of phone number (eg us-domestic, toll-free, etc), to determine which third-party api(s) to use for the order request.



15
16
17
 
# File 'lib/purecloud/models/number_order_request.rb', line 15

def phone_number_type
  @phone_number_type
end

#reservation_ids ⇒ Object

Returns the value of attribute reservation_ids.



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

def reservation_ids
  @reservation_ids
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/purecloud/models/number_order_request.rb', line 18

def self.attribute_map
  {
    
    :'order_tns' => :'orderTns',
    
    :'reservation_ids' => :'reservationIds',
    
    :'order_id' => :'orderId',
    
    :'effective_date' => :'effectiveDate',
    
    :'phone_number_type' => :'phoneNumberType'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/purecloud/models/number_order_request.rb', line 35

def self.swagger_types
  {
    :'order_tns' => :'Array<String>',
    :'reservation_ids' => :'Array<String>',
    :'order_id' => :'String',
    :'effective_date' => :'DateTime',
    :'phone_number_type' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



89
90
91
92
93
94
95
96
97
 
# File 'lib/purecloud/models/number_order_request.rb', line 89

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      order_tns == o.order_tns &&
      reservation_ids == o.reservation_ids &&
      order_id == o.order_id &&
      effective_date == o.effective_date &&
      phone_number_type == o.phone_number_type
end

#_deserialize(type, value) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/purecloud/models/number_order_request.rb', line 129

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



186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/purecloud/models/number_order_request.rb', line 186

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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/purecloud/models/number_order_request.rb', line 110

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


100
101
102
 
# File 'lib/purecloud/models/number_order_request.rb', line 100

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



105
106
107
 
# File 'lib/purecloud/models/number_order_request.rb', line 105

def hash
  [order_tns, reservation_ids, order_id, effective_date, phone_number_type].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



169
170
171
 
# File 'lib/purecloud/models/number_order_request.rb', line 169

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



174
175
176
177
178
179
180
181
182
 
# File 'lib/purecloud/models/number_order_request.rb', line 174

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 



164
165
166
 
# File 'lib/purecloud/models/number_order_request.rb', line 164

def to_s
  to_hash.to_s
end