Class: SubskribeSandboxClient::AccountJson

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/models/account_json.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountJson

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/subskribe_sandbox/models/account_json.rb', line 133

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'customFields')
    if (value = attributes[:'customFields']).is_a?(Hash)
      self.custom_fields = value
    end
  end

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

Instance Attribute Details

#addressObject

Returns the value of attribute address.



49
50
51
# File 'lib/subskribe_sandbox/models/account_json.rb', line 49

def address
  @address
end

#crm_idObject

Returns the value of attribute crm_id.



27
28
29
# File 'lib/subskribe_sandbox/models/account_json.rb', line 27

def crm_id
  @crm_id
end

#crm_typeObject

Returns the value of attribute crm_type.



29
30
31
# File 'lib/subskribe_sandbox/models/account_json.rb', line 29

def crm_type
  @crm_type
end

#currencyObject

Returns the value of attribute currency.



35
36
37
# File 'lib/subskribe_sandbox/models/account_json.rb', line 35

def currency
  @currency
end

#custom_fieldsObject

Returns the value of attribute custom_fields.



53
54
55
# File 'lib/subskribe_sandbox/models/account_json.rb', line 53

def custom_fields
  @custom_fields
end

#descriptionObject

Returns the value of attribute description.



21
22
23
# File 'lib/subskribe_sandbox/models/account_json.rb', line 21

def description
  @description
end

#entity_idsObject

Returns the value of attribute entity_ids.



55
56
57
# File 'lib/subskribe_sandbox/models/account_json.rb', line 55

def entity_ids
  @entity_ids
end

#erp_idObject

Returns the value of attribute erp_id.



31
32
33
# File 'lib/subskribe_sandbox/models/account_json.rb', line 31

def erp_id
  @erp_id
end

#exclude_from_batch_operationsObject

Returns the value of attribute exclude_from_batch_operations.



43
44
45
# File 'lib/subskribe_sandbox/models/account_json.rb', line 43

def exclude_from_batch_operations
  @exclude_from_batch_operations
end

#exclude_from_dunningObject

Returns the value of attribute exclude_from_dunning.



45
46
47
# File 'lib/subskribe_sandbox/models/account_json.rb', line 45

def exclude_from_dunning
  @exclude_from_dunning
end

#external_idObject

Returns the value of attribute external_id.



33
34
35
# File 'lib/subskribe_sandbox/models/account_json.rb', line 33

def external_id
  @external_id
end

#has_automatic_paymentObject

Returns the value of attribute has_automatic_payment.



41
42
43
# File 'lib/subskribe_sandbox/models/account_json.rb', line 41

def has_automatic_payment
  @has_automatic_payment
end

#idObject

Returns the value of attribute id.



17
18
19
# File 'lib/subskribe_sandbox/models/account_json.rb', line 17

def id
  @id
end

#is_resellerObject

Returns the value of attribute is_reseller.



39
40
41
# File 'lib/subskribe_sandbox/models/account_json.rb', line 39

def is_reseller
  @is_reseller
end

#nameObject

Returns the value of attribute name.



19
20
21
# File 'lib/subskribe_sandbox/models/account_json.rb', line 19

def name
  @name
end

#phone_numberObject

Returns the value of attribute phone_number.



23
24
25
# File 'lib/subskribe_sandbox/models/account_json.rb', line 23

def phone_number
  @phone_number
end

#supported_payment_typesObject

Returns the value of attribute supported_payment_types.



47
48
49
# File 'lib/subskribe_sandbox/models/account_json.rb', line 47

def supported_payment_types
  @supported_payment_types
end

#tax_exemption_use_codeObject

Returns the value of attribute tax_exemption_use_code.



37
38
39
# File 'lib/subskribe_sandbox/models/account_json.rb', line 37

def tax_exemption_use_code
  @tax_exemption_use_code
end

#timezoneObject

Returns the value of attribute timezone.



25
26
27
# File 'lib/subskribe_sandbox/models/account_json.rb', line 25

def timezone
  @timezone
end

#updated_onObject

Returns the value of attribute updated_on.



51
52
53
# File 'lib/subskribe_sandbox/models/account_json.rb', line 51

def updated_on
  @updated_on
end

Class Method Details

.attribute_mapObject

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



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/subskribe_sandbox/models/account_json.rb', line 80

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'description' => :'description',
    :'phone_number' => :'phoneNumber',
    :'timezone' => :'timezone',
    :'crm_id' => :'crmId',
    :'crm_type' => :'crmType',
    :'erp_id' => :'erpId',
    :'external_id' => :'externalId',
    :'currency' => :'currency',
    :'tax_exemption_use_code' => :'taxExemptionUseCode',
    :'is_reseller' => :'isReseller',
    :'has_automatic_payment' => :'hasAutomaticPayment',
    :'exclude_from_batch_operations' => :'excludeFromBatchOperations',
    :'exclude_from_dunning' => :'excludeFromDunning',
    :'supported_payment_types' => :'supportedPaymentTypes',
    :'address' => :'address',
    :'updated_on' => :'updatedOn',
    :'custom_fields' => :'customFields',
    :'entity_ids' => :'entityIds'
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'phone_number' => :'String',
    :'timezone' => :'String',
    :'crm_id' => :'String',
    :'crm_type' => :'String',
    :'erp_id' => :'String',
    :'external_id' => :'String',
    :'currency' => :'String',
    :'tax_exemption_use_code' => :'String',
    :'is_reseller' => :'BOOLEAN',
    :'has_automatic_payment' => :'BOOLEAN',
    :'exclude_from_batch_operations' => :'BOOLEAN',
    :'exclude_from_dunning' => :'BOOLEAN',
    :'supported_payment_types' => :'Array<String>',
    :'address' => :'AccountAddressJson',
    :'updated_on' => :'Integer',
    :'custom_fields' => :'Hash<String, CustomFieldValue>',
    :'entity_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
# File 'lib/subskribe_sandbox/models/account_json.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      phone_number == o.phone_number &&
      timezone == o.timezone &&
      crm_id == o.crm_id &&
      crm_type == o.crm_type &&
      erp_id == o.erp_id &&
      external_id == o.external_id &&
      currency == o.currency &&
      tax_exemption_use_code == o.tax_exemption_use_code &&
      is_reseller == o.is_reseller &&
      has_automatic_payment == o.has_automatic_payment &&
      exclude_from_batch_operations == o.exclude_from_batch_operations &&
      exclude_from_dunning == o.exclude_from_dunning &&
      supported_payment_types == o.supported_payment_types &&
      address == o.address &&
      updated_on == o.updated_on &&
      custom_fields == o.custom_fields &&
      entity_ids == o.entity_ids
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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# File 'lib/subskribe_sandbox/models/account_json.rb', line 314

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



380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'lib/subskribe_sandbox/models/account_json.rb', line 380

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'lib/subskribe_sandbox/models/account_json.rb', line 293

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


280
281
282
# File 'lib/subskribe_sandbox/models/account_json.rb', line 280

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



286
287
288
# File 'lib/subskribe_sandbox/models/account_json.rb', line 286

def hash
  [id, name, description, phone_number, timezone, crm_id, crm_type, erp_id, external_id, currency, tax_exemption_use_code, is_reseller, has_automatic_payment, exclude_from_batch_operations, exclude_from_dunning, supported_payment_types, address, updated_on, custom_fields, entity_ids].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



228
229
230
231
# File 'lib/subskribe_sandbox/models/account_json.rb', line 228

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



360
361
362
# File 'lib/subskribe_sandbox/models/account_json.rb', line 360

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



366
367
368
369
370
371
372
373
374
# File 'lib/subskribe_sandbox/models/account_json.rb', line 366

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



354
355
356
# File 'lib/subskribe_sandbox/models/account_json.rb', line 354

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



235
236
237
238
239
# File 'lib/subskribe_sandbox/models/account_json.rb', line 235

def valid?
  tax_exemption_use_code_validator = EnumAttributeValidator.new('String', ['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'P', 'Q', 'R'])
  return false unless tax_exemption_use_code_validator.valid?(@tax_exemption_use_code)
  true
end