Class: ClickSendClient::Subaccount

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

Overview

Accounts that are maintained under a main account

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Subaccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
90
91
92
93
94
95
96
97
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
 
# File 'lib/clicksend_client/models/subaccount.rb', line 87

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

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

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

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

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

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

  if attributes.has_key?(:'access_users')
    self.access_users = attributes[:'access_users']
  else
    self.access_users = 1
  end

  if attributes.has_key?(:'access_billing')
    self.access_billing = attributes[:'access_billing']
  else
    self.access_billing = 1
  end

  if attributes.has_key?(:'access_reporting')
    self.access_reporting = attributes[:'access_reporting']
  else
    self.access_reporting = 1
  end

  if attributes.has_key?(:'access_contacts')
    self.access_contacts = attributes[:'access_contacts']
  else
    self.access_contacts = 0
  end

  if attributes.has_key?(:'access_settings')
    self.access_settings = attributes[:'access_settings']
  else
    self.access_settings = 1
  end
end

Instance Attribute Details

#access_billing ⇒ Object

Your access billing flag value, must be 1 or 0.



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

def access_billing
  @access_billing
end

#access_contacts ⇒ Object

Your access contacts flag value, must be 1 or 0.



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

def access_contacts
  @access_contacts
end

#access_reporting ⇒ Object

Your access reporting flag value, must be 1 or 0.



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

def access_reporting
  @access_reporting
end

#access_settings ⇒ Object

Your access settings flag value, must be 1 or 0.



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

def access_settings
  @access_settings
end

#access_users ⇒ Object

Your access users flag value, must be 1 or 0.



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

def access_users
  @access_users
end

#api_username ⇒ Object

Your new api username.



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

def api_username
  @api_username
end

#email ⇒ Object

Your new email.



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

def email
  @email
end

#first_name ⇒ Object

Your firstname



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

def first_name
  @first_name
end

#last_name ⇒ Object

Your lastname



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

def last_name
  @last_name
end

#password ⇒ Object

Your new password



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

def password
  @password
end

#phone_number ⇒ Object

Your phone number in E.164 format.



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

def phone_number
  @phone_number
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/clicksend_client/models/subaccount.rb', line 52

def self.attribute_map
  {
    :'api_username' => :'api_username',
    :'password' => :'password',
    :'email' => :'email',
    :'phone_number' => :'phone_number',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'access_users' => :'access_users',
    :'access_billing' => :'access_billing',
    :'access_reporting' => :'access_reporting',
    :'access_contacts' => :'access_contacts',
    :'access_settings' => :'access_settings'
  }
end

.clicksend_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/clicksend_client/models/subaccount.rb', line 69

def self.clicksend_types
  {
    :'api_username' => :'String',
    :'password' => :'String',
    :'email' => :'String',
    :'phone_number' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'access_users' => :'Integer',
    :'access_billing' => :'Integer',
    :'access_reporting' => :'Integer',
    :'access_contacts' => :'Integer',
    :'access_settings' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/clicksend_client/models/subaccount.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      api_username == o.api_username &&
      password == o.password &&
      email == o.email &&
      phone_number == o.phone_number &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      access_users == o.access_users &&
      access_billing == o.access_billing &&
      access_reporting == o.access_reporting &&
      access_contacts == o.access_contacts &&
      access_settings == o.access_settings
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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/clicksend_client/models/subaccount.rb', line 245

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/clicksend_client/models/subaccount.rb', line 311

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/clicksend_client/models/subaccount.rb', line 224

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


211
212
213
 
# File 'lib/clicksend_client/models/subaccount.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



217
218
219
 
# File 'lib/clicksend_client/models/subaccount.rb', line 217

def hash
  [api_username, password, email, phone_number, first_name, last_name, access_users, access_billing, access_reporting, access_contacts, access_settings].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



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

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

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

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

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

  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



291
292
293
 
# File 'lib/clicksend_client/models/subaccount.rb', line 291

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



297
298
299
300
301
302
303
304
305
 
# File 'lib/clicksend_client/models/subaccount.rb', line 297

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



285
286
287
 
# File 'lib/clicksend_client/models/subaccount.rb', line 285

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



181
182
183
184
185
186
187
188
189
 
# File 'lib/clicksend_client/models/subaccount.rb', line 181

def valid?
  return false if @api_username.nil?
  return false if @password.nil?
  return false if @email.nil?
  return false if @phone_number.nil?
  return false if @first_name.nil?
  return false if @last_name.nil?
  true
end