Class: MailSlurpClient::PhoneProvisioningJobItemDto

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PhoneProvisioningJobItemDto

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 99

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::PhoneProvisioningJobItemDto` 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 `MailSlurpClient::PhoneProvisioningJobItemDto`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#carrier_name ⇒ Object

Returns the value of attribute carrier_name.



27
28
29
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 27

def carrier_name
  @carrier_name
end

#failure_message ⇒ Object

Returns the value of attribute failure_message.



35
36
37
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 35

def failure_message
  @failure_message
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 17

def id
  @id
end

#line_type ⇒ Object

Returns the value of attribute line_type.



25
26
27
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 25

def line_type
  @line_type
end

#mobile_country_code ⇒ Object

Returns the value of attribute mobile_country_code.



29
30
31
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 29

def mobile_country_code
  @mobile_country_code
end

#mobile_network_code ⇒ Object

Returns the value of attribute mobile_network_code.



31
32
33
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 31

def mobile_network_code
  @mobile_network_code
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



19
20
21
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 19

def phone_number
  @phone_number
end

#phone_number_id ⇒ Object

Returns the value of attribute phone_number_id.



33
34
35
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 33

def phone_number_id
  @phone_number_id
end

#provider_label ⇒ Object

Returns the value of attribute provider_label.



21
22
23
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 21

def provider_label
  @provider_label
end

#status ⇒ Object

Returns the value of attribute status.



23
24
25
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 23

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 60

def self.attribute_map
  {
    :'id' => :'id',
    :'phone_number' => :'phoneNumber',
    :'provider_label' => :'providerLabel',
    :'status' => :'status',
    :'line_type' => :'lineType',
    :'carrier_name' => :'carrierName',
    :'mobile_country_code' => :'mobileCountryCode',
    :'mobile_network_code' => :'mobileNetworkCode',
    :'phone_number_id' => :'phoneNumberId',
    :'failure_message' => :'failureMessage'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



225
226
227
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 225

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 76

def self.openapi_types
  {
    :'id' => :'String',
    :'phone_number' => :'String',
    :'provider_label' => :'String',
    :'status' => :'String',
    :'line_type' => :'String',
    :'carrier_name' => :'String',
    :'mobile_country_code' => :'String',
    :'mobile_network_code' => :'String',
    :'phone_number_id' => :'String',
    :'failure_message' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      phone_number == o.phone_number &&
      provider_label == o.provider_label &&
      status == o.status &&
      line_type == o.line_type &&
      carrier_name == o.carrier_name &&
      mobile_country_code == o.mobile_country_code &&
      mobile_network_code == o.mobile_network_code &&
      phone_number_id == o.phone_number_id &&
      failure_message == o.failure_message
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



253
254
255
256
257
258
259
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
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 253

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 =~ /\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
    MailSlurpClient.const_get(type).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:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 322

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:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 232

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


212
213
214
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 212

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



218
219
220
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 218

def hash
  [id, phone_number, provider_label, status, line_type, carrier_name, mobile_country_code, mobile_network_code, phone_number_id, failure_message].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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 155

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @phone_number.nil?
    invalid_properties.push('invalid value for "phone_number", phone_number cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



298
299
300
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 298

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 304

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) —

    String presentation of the object



292
293
294
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 292

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



174
175
176
177
178
179
180
181
 
# File 'lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb', line 174

def valid?
  return false if @id.nil?
  return false if @phone_number.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["PENDING", "PROVISIONING", "PROVISIONED", "UNAVAILABLE", "FAILED"])
  return false unless status_validator.valid?(@status)
  true
end