Class: ClickSendClient::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/models/address.rb

Overview

Base model for all address-related objects.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Address

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/clicksend_client/models/address.rb', line 67

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'address_name')
    self.address_name = attributes[:'address_name']
  end

  if attributes.has_key?(:'address_line_1')
    self.address_line_1 = attributes[:'address_line_1']
  end

  if attributes.has_key?(:'address_city')
    self.address_city = attributes[:'address_city']
  end

  if attributes.has_key?(:'address_postal_code')
    self.address_postal_code = attributes[:'address_postal_code']
  end

  if attributes.has_key?(:'address_country')
    self.address_country = attributes[:'address_country']
  end

  if attributes.has_key?(:'address_line_2')
    self.address_line_2 = attributes[:'address_line_2']
  end

  if attributes.has_key?(:'address_state')
    self.address_state = attributes[:'address_state']
  end
end

Instance Attribute Details

#address_city ⇒ Object

Your city



25
26
27
 
# File 'lib/clicksend_client/models/address.rb', line 25

def address_city
  @address_city
end

#address_country ⇒ Object

Your country



31
32
33
 
# File 'lib/clicksend_client/models/address.rb', line 31

def address_country
  @address_country
end

#address_line_1 ⇒ Object

Your address line 1



22
23
24
 
# File 'lib/clicksend_client/models/address.rb', line 22

def address_line_1
  @address_line_1
end

#address_line_2 ⇒ Object

Your address line 2



34
35
36
 
# File 'lib/clicksend_client/models/address.rb', line 34

def address_line_2
  @address_line_2
end

#address_name ⇒ Object

Your address name.



19
20
21
 
# File 'lib/clicksend_client/models/address.rb', line 19

def address_name
  @address_name
end

#address_postal_code ⇒ Object

Your postal code



28
29
30
 
# File 'lib/clicksend_client/models/address.rb', line 28

def address_postal_code
  @address_postal_code
end

#address_state ⇒ Object

Your state



37
38
39
 
# File 'lib/clicksend_client/models/address.rb', line 37

def address_state
  @address_state
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/clicksend_client/models/address.rb', line 40

def self.attribute_map
  {
    :'address_name' => :'address_name',
    :'address_line_1' => :'address_line_1',
    :'address_city' => :'address_city',
    :'address_postal_code' => :'address_postal_code',
    :'address_country' => :'address_country',
    :'address_line_2' => :'address_line_2',
    :'address_state' => :'address_state'
  }
end

.clicksend_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/clicksend_client/models/address.rb', line 53

def self.clicksend_types
  {
    :'address_name' => :'String',
    :'address_line_1' => :'String',
    :'address_city' => :'String',
    :'address_postal_code' => :'String',
    :'address_country' => :'String',
    :'address_line_2' => :'String',
    :'address_state' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/clicksend_client/models/address.rb', line 142

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_name == o.address_name &&
      address_line_1 == o.address_line_1 &&
      address_city == o.address_city &&
      address_postal_code == o.address_postal_code &&
      address_country == o.address_country &&
      address_line_2 == o.address_line_2 &&
      address_state == o.address_state
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



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
226
 
# File 'lib/clicksend_client/models/address.rb', line 190

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
    temp_model = ClickSendClient.const_get(type).new
    temp_model.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



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/clicksend_client/models/address.rb', line 256

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/clicksend_client/models/address.rb', line 169

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.clicksend_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


156
157
158
 
# File 'lib/clicksend_client/models/address.rb', line 156

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
 
# File 'lib/clicksend_client/models/address.rb', line 162

def hash
  [address_name, address_line_1, address_city, address_postal_code, address_country, address_line_2, address_state].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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/clicksend_client/models/address.rb', line 104

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

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

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

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

  if @address_country.nil?
    invalid_properties.push('invalid value for "address_country", address_country 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



236
237
238
 
# File 'lib/clicksend_client/models/address.rb', line 236

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



242
243
244
245
246
247
248
249
250
 
# File 'lib/clicksend_client/models/address.rb', line 242

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

Returns:

  • (String) —

    String presentation of the object



230
231
232
 
# File 'lib/clicksend_client/models/address.rb', line 230

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



131
132
133
134
135
136
137
138
 
# File 'lib/clicksend_client/models/address.rb', line 131

def valid?
  return false if @address_name.nil?
  return false if @address_line_1.nil?
  return false if @address_city.nil?
  return false if @address_postal_code.nil?
  return false if @address_country.nil?
  true
end