Class: SibApiV3Sdk::GetAccount

Inherits:
Object
  • Object
show all
Defined in:
lib/sib-api-v3-sdk/models/get_account.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
104
105
106
107
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 68

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

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

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

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

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

  if attributes.has_key?(:'plan')
    if (value = attributes[:'plan']).is_a?(Array)
      self.plan = value
    end
  end

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



29
30
31
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 29

def address
  @address
end

#company_name ⇒ Object

Name of the company



27
28
29
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 27

def company_name
  @company_name
end

#email ⇒ Object

Login Email



18
19
20
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 18

def email
  @email
end

#first_name ⇒ Object

First Name



21
22
23
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 21

def first_name
  @first_name
end

#last_name ⇒ Object

Last Name



24
25
26
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 24

def last_name
  @last_name
end

#marketing_automation ⇒ Object

Returns the value of attribute marketing_automation.



36
37
38
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 36

def marketing_automation
  @marketing_automation
end

#plan ⇒ Object

Information about your plans and credits



32
33
34
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 32

def plan
  @plan
end

#relay ⇒ Object

Returns the value of attribute relay.



34
35
36
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 34

def relay
  @relay
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 39

def self.attribute_map
  {
    :'email' => :'email',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'company_name' => :'companyName',
    :'address' => :'address',
    :'plan' => :'plan',
    :'relay' => :'relay',
    :'marketing_automation' => :'marketingAutomation'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 53

def self.swagger_types
  {
    :'email' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'company_name' => :'String',
    :'address' => :'GetExtendedClientAddress',
    :'plan' => :'Array<GetAccountPlan>',
    :'relay' => :'GetAccountRelay',
    :'marketing_automation' => :'GetAccountMarketingAutomation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      company_name == o.company_name &&
      address == o.address &&
      plan == o.plan &&
      relay == o.relay &&
      marketing_automation == o.marketing_automation
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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 208

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 = SibApiV3Sdk.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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 274

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 187

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


174
175
176
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



180
181
182
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 180

def hash
  [email, first_name, last_name, company_name, address, plan, relay, marketing_automation].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



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
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 111

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

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

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

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

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

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

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



254
255
256
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 254

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



260
261
262
263
264
265
266
267
268
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 260

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



248
249
250
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 248

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



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/sib-api-v3-sdk/models/get_account.rb', line 146

def valid?
  return false if @email.nil?
  return false if @first_name.nil?
  return false if @last_name.nil?
  return false if @company_name.nil?
  return false if @address.nil?
  return false if @plan.nil?
  return false if @relay.nil?
  true
end