Class: ClickSendClient::Contact

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

Overview

Contains all details for the main contact.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Contact

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/clicksend_client/models/contact.rb', line 112

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?(:'phone_number')
    self.phone_number = attributes[:'phone_number']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'address_state')
    self.address_state = attributes[:'address_state']
  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?(:'organization_name')
    self.organization_name = attributes[:'organization_name']
  end

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

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

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

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

Instance Attribute Details

#address_city ⇒ Object

Your nearest city



40
41
42
 
# File 'lib/clicksend_client/models/contact.rb', line 40

def address_city
  @address_city
end

#address_country ⇒ Object

Your current country



49
50
51
 
# File 'lib/clicksend_client/models/contact.rb', line 49

def address_country
  @address_country
end

#address_line_1 ⇒ Object

Your street address



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

def address_line_1
  @address_line_1
end

#address_line_2 ⇒ Object

Returns the value of attribute address_line_2.



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

def address_line_2
  @address_line_2
end

#address_postal_code ⇒ Object

Your current postcode



46
47
48
 
# File 'lib/clicksend_client/models/contact.rb', line 46

def address_postal_code
  @address_postal_code
end

#address_state ⇒ Object

Your current state



43
44
45
 
# File 'lib/clicksend_client/models/contact.rb', line 43

def address_state
  @address_state
end

#custom_1 ⇒ Object

Returns the value of attribute custom_1.



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

def custom_1
  @custom_1
end

#custom_2 ⇒ Object

Returns the value of attribute custom_2.



55
56
57
 
# File 'lib/clicksend_client/models/contact.rb', line 55

def custom_2
  @custom_2
end

#custom_3 ⇒ Object

Returns the value of attribute custom_3.



58
59
60
 
# File 'lib/clicksend_client/models/contact.rb', line 58

def custom_3
  @custom_3
end

#custom_4 ⇒ Object

Returns the value of attribute custom_4.



61
62
63
 
# File 'lib/clicksend_client/models/contact.rb', line 61

def custom_4
  @custom_4
end

#email ⇒ Object

Your email. Must be provided if no phone number or fax number.



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

def email
  @email
end

#fax_number ⇒ Object

Your fax number. Must be provided if no phone number or email.



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

def fax_number
  @fax_number
end

#first_name ⇒ Object

Your first name.



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

def first_name
  @first_name
end

#last_name ⇒ Object

Your last name



64
65
66
 
# File 'lib/clicksend_client/models/contact.rb', line 64

def last_name
  @last_name
end

#organization_name ⇒ Object

Your organisation name



52
53
54
 
# File 'lib/clicksend_client/models/contact.rb', line 52

def organization_name
  @organization_name
end

#phone_number ⇒ Object

Your phone number in E.164 format. Must be provided if no fax number or email.



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

def phone_number
  @phone_number
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/clicksend_client/models/contact.rb', line 67

def self.attribute_map
  {
    :'phone_number' => :'phone_number',
    :'custom_1' => :'custom_1',
    :'email' => :'email',
    :'fax_number' => :'fax_number',
    :'first_name' => :'first_name',
    :'address_line_1' => :'address_line_1',
    :'address_line_2' => :'address_line_2',
    :'address_city' => :'address_city',
    :'address_state' => :'address_state',
    :'address_postal_code' => :'address_postal_code',
    :'address_country' => :'address_country',
    :'organization_name' => :'organization_name',
    :'custom_2' => :'custom_2',
    :'custom_3' => :'custom_3',
    :'custom_4' => :'custom_4',
    :'last_name' => :'last_name'
  }
end

.clicksend_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/clicksend_client/models/contact.rb', line 89

def self.clicksend_types
  {
    :'phone_number' => :'String',
    :'custom_1' => :'String',
    :'email' => :'String',
    :'fax_number' => :'String',
    :'first_name' => :'String',
    :'address_line_1' => :'String',
    :'address_line_2' => :'String',
    :'address_city' => :'String',
    :'address_state' => :'String',
    :'address_postal_code' => :'String',
    :'address_country' => :'String',
    :'organization_name' => :'String',
    :'custom_2' => :'String',
    :'custom_3' => :'String',
    :'custom_4' => :'String',
    :'last_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/clicksend_client/models/contact.rb', line 208

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      phone_number == o.phone_number &&
      custom_1 == o.custom_1 &&
      email == o.email &&
      fax_number == o.fax_number &&
      first_name == o.first_name &&
      address_line_1 == o.address_line_1 &&
      address_line_2 == o.address_line_2 &&
      address_city == o.address_city &&
      address_state == o.address_state &&
      address_postal_code == o.address_postal_code &&
      address_country == o.address_country &&
      organization_name == o.organization_name &&
      custom_2 == o.custom_2 &&
      custom_3 == o.custom_3 &&
      custom_4 == o.custom_4 &&
      last_name == o.last_name
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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/clicksend_client/models/contact.rb', line 265

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/clicksend_client/models/contact.rb', line 331

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/clicksend_client/models/contact.rb', line 244

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


231
232
233
 
# File 'lib/clicksend_client/models/contact.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



237
238
239
 
# File 'lib/clicksend_client/models/contact.rb', line 237

def hash
  [phone_number, custom_1, email, fax_number, first_name, address_line_1, address_line_2, address_city, address_state, address_postal_code, address_country, organization_name, custom_2, custom_3, custom_4, last_name].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



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/clicksend_client/models/contact.rb', line 185

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

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



311
312
313
 
# File 'lib/clicksend_client/models/contact.rb', line 311

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



317
318
319
320
321
322
323
324
325
 
# File 'lib/clicksend_client/models/contact.rb', line 317

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



305
306
307
 
# File 'lib/clicksend_client/models/contact.rb', line 305

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



200
201
202
203
204
 
# File 'lib/clicksend_client/models/contact.rb', line 200

def valid?
  return false if @phone_number.nil?
  return false if @custom_1.nil?
  true
end