Class: Bfwd::Account

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/account.rb

Overview

Account

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Account

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/bf_ruby2/models/account.rb', line 102

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'deleted')
    self.deleted = attributes[:'deleted']
  else
    self.deleted = false
  end

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

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

end

Instance Attribute Details

#aggregating_product_rate_plan_id ⇒ Object

{ "description" : "If present, this will be the product rate plan to use when creating an aggregating subscription. An account level aggregating subscription will be created when the first subscription is created against the account.", "verbs":[] }



46
47
48
 
# File 'lib/bf_ruby2/models/account.rb', line 46

def aggregating_product_rate_plan_id
  @aggregating_product_rate_plan_id
end

#aggregating_subscription_id ⇒ Object

{ "description" : "The consistent ID of the account level aggregating subscription, if one exists.", "verbs":[] }



49
50
51
 
# File 'lib/bf_ruby2/models/account.rb', line 49

def aggregating_subscription_id
  @aggregating_subscription_id
end

#changed_by ⇒ Object

{ "description" : "ID of the user who last updated the entity.", "verbs":[] }



25
26
27
 
# File 'lib/bf_ruby2/models/account.rb', line 25

def changed_by
  @changed_by
end

#created ⇒ Object

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }



22
23
24
 
# File 'lib/bf_ruby2/models/account.rb', line 22

def created
  @created
end

#crm_id ⇒ Object

{ "description" : "CRM ID of the account.", "verbs“: }



19
20
21
 
# File 'lib/bf_ruby2/models/account.rb', line 19

def crm_id
  @crm_id
end

#deleted ⇒ Object

{ "default" : "false", "description" : "Indicates if an account has been retired. If an account has been retired it can still be retrieved using the appropriate flag on API requests.", "verbs“: }



52
53
54
 
# File 'lib/bf_ruby2/models/account.rb', line 52

def deleted
  @deleted
end

#id ⇒ Object

{ "description" : "ID of the account.", "verbs“: }



34
35
36
 
# File 'lib/bf_ruby2/models/account.rb', line 34

def id
  @id
end

#metadata ⇒ Object

{ "description" : "Add metadata.", "verbs“: }



31
32
33
 
# File 'lib/bf_ruby2/models/account.rb', line 31

def metadata
  @metadata
end

#organization_id ⇒ Object

{ "description" : "Organization associated with the account.", "verbs":[] }



37
38
39
 
# File 'lib/bf_ruby2/models/account.rb', line 37

def organization_id
  @organization_id
end

#payment_methods ⇒ Object

{ "description" : "The payment-methods associated with the account.", "verbs“: }



57
58
59
 
# File 'lib/bf_ruby2/models/account.rb', line 57

def payment_methods
  @payment_methods
end

#profile ⇒ Object

Returns the value of attribute profile.



54
55
56
 
# File 'lib/bf_ruby2/models/account.rb', line 54

def profile
  @profile
end

#successful_subscriptions ⇒ Object

{ "description" : "Number of distinct, paid subscriptions associated with this account. Initially the value will be 0 when no successful subscriptions have been taken. A subscription cancelled whilst in trial is counted as successful.", "verbs“: }



43
44
45
 
# File 'lib/bf_ruby2/models/account.rb', line 43

def successful_subscriptions
  @successful_subscriptions
end

#updated ⇒ Object

{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }



28
29
30
 
# File 'lib/bf_ruby2/models/account.rb', line 28

def updated
  @updated
end

#user_id ⇒ Object

{ "description" : "User associated with the account. If this is null, no user is currently assocaited with the account. A user is only set when an account is associated with a user account.", "verbs":[] }



40
41
42
 
# File 'lib/bf_ruby2/models/account.rb', line 40

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/bf_ruby2/models/account.rb', line 61

def self.attribute_map
  {
    :'crm_id' => :'crmID',
    :'created' => :'created',
    :'changed_by' => :'changedBy',
    :'updated' => :'updated',
    :'metadata' => :'metadata',
    :'id' => :'id',
    :'organization_id' => :'organizationID',
    :'user_id' => :'userID',
    :'successful_subscriptions' => :'successfulSubscriptions',
    :'aggregating_product_rate_plan_id' => :'aggregatingProductRatePlanID',
    :'aggregating_subscription_id' => :'aggregatingSubscriptionID',
    :'deleted' => :'deleted',
    :'profile' => :'profile',
    :'payment_methods' => :'paymentMethods'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/bf_ruby2/models/account.rb', line 81

def self.swagger_types
  {
    :'crm_id' => :'String',
    :'created' => :'DateTime',
    :'changed_by' => :'String',
    :'updated' => :'DateTime',
    :'metadata' => :'DynamicMetadata',
    :'id' => :'String',
    :'organization_id' => :'String',
    :'user_id' => :'String',
    :'successful_subscriptions' => :'Integer',
    :'aggregating_product_rate_plan_id' => :'String',
    :'aggregating_subscription_id' => :'String',
    :'deleted' => :'BOOLEAN',
    :'profile' => :'Profile',
    :'payment_methods' => :'Array<PaymentMethod>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/bf_ruby2/models/account.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      crm_id == o.crm_id &&
      created == o.created &&
      changed_by == o.changed_by &&
      updated == o.updated &&
      metadata == o.metadata &&
      id == o.id &&
      organization_id == o.organization_id &&
      user_id == o.user_id &&
      successful_subscriptions == o.successful_subscriptions &&
      aggregating_product_rate_plan_id == o.aggregating_product_rate_plan_id &&
      aggregating_subscription_id == o.aggregating_subscription_id &&
      deleted == o.deleted &&
      profile == o.profile &&
      payment_methods == o.payment_methods
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



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
282
283
284
285
286
 
# File 'lib/bf_ruby2/models/account.rb', line 250

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/bf_ruby2/models/account.rb', line 316

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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/bf_ruby2/models/account.rb', line 229

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 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


216
217
218
 
# File 'lib/bf_ruby2/models/account.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



222
223
224
 
# File 'lib/bf_ruby2/models/account.rb', line 222

def hash
  [crm_id, created, changed_by, updated, metadata, id, organization_id, user_id, successful_subscriptions, aggregating_product_rate_plan_id, aggregating_subscription_id, deleted, profile, payment_methods].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/bf_ruby2/models/account.rb', line 172

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

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

  return 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



296
297
298
 
# File 'lib/bf_ruby2/models/account.rb', line 296

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



302
303
304
305
306
307
308
309
310
 
# File 'lib/bf_ruby2/models/account.rb', line 302

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



290
291
292
 
# File 'lib/bf_ruby2/models/account.rb', line 290

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



187
188
189
190
191
 
# File 'lib/bf_ruby2/models/account.rb', line 187

def valid?
  return false if @id.nil?
  return false if @organization_id.nil?
  return true
end