Class: OpenapiClient::ConnectRoyalMailRequestBody

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/connect_royal_mail_request_body.rb

Overview

A Royal Mail account information request body

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConnectRoyalMailRequestBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 98

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_number ⇒ Object

Account number



19
20
21
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 19

def 
  @account_number
end

#city ⇒ Object

City



43
44
45
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 43

def city
  @city
end

#company_name ⇒ Object

Company name



31
32
33
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 31

def company_name
  @company_name
end

#contact_name ⇒ Object

Contact name



25
26
27
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 25

def contact_name
  @contact_name
end

#email ⇒ Object

The email address



28
29
30
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 28

def email
  @email
end

#nickname ⇒ Object

Nickname



52
53
54
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 52

def nickname
  @nickname
end

#oba_email ⇒ Object

The oba email address



22
23
24
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 22

def oba_email
  @oba_email
end

#phone ⇒ Object

Phone



49
50
51
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 49

def phone
  @phone
end

#postal_code ⇒ Object

Postal code



46
47
48
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 46

def postal_code
  @postal_code
end

#street_line1 ⇒ Object

Street line1



34
35
36
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 34

def street_line1
  @street_line1
end

#street_line2 ⇒ Object

Street line2



37
38
39
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 37

def street_line2
  @street_line2
end

#street_line3 ⇒ Object

Street line3



40
41
42
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 40

def street_line3
  @street_line3
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 55

def self.attribute_map
  {
    :'account_number' => :'account_number',
    :'oba_email' => :'oba_email',
    :'contact_name' => :'contact_name',
    :'email' => :'email',
    :'company_name' => :'company_name',
    :'street_line1' => :'street_line1',
    :'street_line2' => :'street_line2',
    :'street_line3' => :'street_line3',
    :'city' => :'city',
    :'postal_code' => :'postal_code',
    :'phone' => :'phone',
    :'nickname' => :'nickname'
  }
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



402
403
404
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 402

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 91

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

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 73

def self.openapi_types
  {
    :'account_number' => :'String',
    :'oba_email' => :'String',
    :'contact_name' => :'String',
    :'email' => :'String',
    :'company_name' => :'String',
    :'street_line1' => :'String',
    :'street_line2' => :'String',
    :'street_line3' => :'String',
    :'city' => :'String',
    :'postal_code' => :'String',
    :'phone' => :'String',
    :'nickname' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 370

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      oba_email == o.oba_email &&
      contact_name == o.contact_name &&
      email == o.email &&
      company_name == o.company_name &&
      street_line1 == o.street_line1 &&
      street_line2 == o.street_line2 &&
      street_line3 == o.street_line3 &&
      city == o.city &&
      postal_code == o.postal_code &&
      phone == o.phone &&
      nickname == o.nickname
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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 430

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
    OpenapiClient.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



499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 499

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



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 409

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


389
390
391
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 389

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



395
396
397
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 395

def hash
  [, oba_email, contact_name, email, company_name, street_line1, street_line2, street_line3, city, postal_code, phone, nickname].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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
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
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 162

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

  if @account_number.to_s.length < 1
    invalid_properties.push('invalid value for "account_number", the character length must be great than or equal to 1.')
  end

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

  if @contact_name.to_s.length < 1
    invalid_properties.push('invalid value for "contact_name", the character length must be great than or equal to 1.')
  end

  if !@company_name.nil? && @company_name.to_s.length < 1
    invalid_properties.push('invalid value for "company_name", the character length must be great than or equal to 1.')
  end

  if !@street_line1.nil? && @street_line1.to_s.length < 1
    invalid_properties.push('invalid value for "street_line1", the character length must be great than or equal to 1.')
  end

  if !@street_line2.nil? && @street_line2.to_s.length < 1
    invalid_properties.push('invalid value for "street_line2", the character length must be great than or equal to 1.')
  end

  if !@street_line3.nil? && @street_line3.to_s.length < 1
    invalid_properties.push('invalid value for "street_line3", the character length must be great than or equal to 1.')
  end

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

  if @city.to_s.length < 1
    invalid_properties.push('invalid value for "city", the character length must be great than or equal to 1.')
  end

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

  if @postal_code.to_s.length < 1
    invalid_properties.push('invalid value for "postal_code", the character length must be great than or equal to 1.')
  end

  if !@phone.nil? && @phone.to_s.length < 1
    invalid_properties.push('invalid value for "phone", the character length must be great than or equal to 1.')
  end

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

  if @nickname.to_s.length < 1
    invalid_properties.push('invalid value for "nickname", the character length must be great than or equal to 1.')
  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



475
476
477
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 475

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



481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 481

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



469
470
471
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 469

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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/openapi_client/models/connect_royal_mail_request_body.rb', line 229

def valid?
  return false if @account_number.nil?
  return false if @account_number.to_s.length < 1
  return false if @contact_name.nil?
  return false if @contact_name.to_s.length < 1
  return false if !@company_name.nil? && @company_name.to_s.length < 1
  return false if !@street_line1.nil? && @street_line1.to_s.length < 1
  return false if !@street_line2.nil? && @street_line2.to_s.length < 1
  return false if !@street_line3.nil? && @street_line3.to_s.length < 1
  return false if @city.nil?
  return false if @city.to_s.length < 1
  return false if @postal_code.nil?
  return false if @postal_code.to_s.length < 1
  return false if !@phone.nil? && @phone.to_s.length < 1
  return false if @nickname.nil?
  return false if @nickname.to_s.length < 1
  true
end