Class: Yapstone::Renter

Inherits:
Object
  • Object
show all
Defined in:
lib/yapstone-payments/models/renter.rb

Overview

Details about the renter including contact information and where the renter lives.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Renter

Initializes the object



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
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
 
# File 'lib/yapstone-payments/models/renter.rb', line 63

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



20
21
22
 
# File 'lib/yapstone-payments/models/renter.rb', line 20

def address
  @address
end

#email_address ⇒ Object

The email address of the customer.



23
24
25
 
# File 'lib/yapstone-payments/models/renter.rb', line 23

def email_address
  @email_address
end

#external_renter_id ⇒ Object

If you are transferring renter information from another system, or use a different tracking method externally, you can store it here.



33
34
35
 
# File 'lib/yapstone-payments/models/renter.rb', line 33

def external_renter_id
  @external_renter_id
end

#name ⇒ Object

Returns the value of attribute name.



25
26
27
 
# File 'lib/yapstone-payments/models/renter.rb', line 25

def name
  @name
end

#phone ⇒ Object

Returns the value of attribute phone.



27
28
29
 
# File 'lib/yapstone-payments/models/renter.rb', line 27

def phone
  @phone
end

#renter_id ⇒ Object

ID of the renter



30
31
32
 
# File 'lib/yapstone-payments/models/renter.rb', line 30

def renter_id
  @renter_id
end

#same_as_customer ⇒ Object

Returns the value of attribute same_as_customer.



18
19
20
 
# File 'lib/yapstone-payments/models/renter.rb', line 18

def same_as_customer
  @same_as_customer
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/yapstone-payments/models/renter.rb', line 36

def self.attribute_map
  {
    :'same_as_customer' => :'sameAsCustomer',
    :'address' => :'address',
    :'email_address' => :'emailAddress',
    :'name' => :'name',
    :'phone' => :'phone',
    :'renter_id' => :'renterId',
    :'external_renter_id' => :'externalRenterId'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



147
148
149
 
# File 'lib/yapstone-payments/models/renter.rb', line 147

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/yapstone-payments/models/renter.rb', line 49

def self.openapi_types
  {
    :'same_as_customer' => :'String',
    :'address' => :'Address',
    :'email_address' => :'String',
    :'name' => :'Name',
    :'phone' => :'Phone',
    :'renter_id' => :'String',
    :'external_renter_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/yapstone-payments/models/renter.rb', line 120

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      same_as_customer == o.same_as_customer &&
      address == o.address &&
      email_address == o.email_address &&
      name == o.name &&
      phone == o.phone &&
      renter_id == o.renter_id &&
      external_renter_id == o.external_renter_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
 
# File 'lib/yapstone-payments/models/renter.rb', line 175

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



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/yapstone-payments/models/renter.rb', line 240

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/yapstone-payments/models/renter.rb', line 154

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

See Also:

  • `==` method


134
135
136
 
# File 'lib/yapstone-payments/models/renter.rb', line 134

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



140
141
142
 
# File 'lib/yapstone-payments/models/renter.rb', line 140

def hash
  [same_as_customer, address, email_address, name, phone, renter_id, external_renter_id].hash
end

#list_invalid_properties ⇒ Object

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



107
108
109
110
 
# File 'lib/yapstone-payments/models/renter.rb', line 107

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



220
221
222
 
# File 'lib/yapstone-payments/models/renter.rb', line 220

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
 
# File 'lib/yapstone-payments/models/renter.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_s ⇒ String

Returns the string representation of the object



214
215
216
 
# File 'lib/yapstone-payments/models/renter.rb', line 214

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



114
115
116
 
# File 'lib/yapstone-payments/models/renter.rb', line 114

def valid?
  true
end