Class: TalonOne::AccountLimits

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/account_limits.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountLimits

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
169
170
171
172
173
174
175
176
177
 
# File 'lib/talon_one/models/account_limits.rb', line 107

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::AccountLimits` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::AccountLimits`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'live_applications')
    self.live_applications = attributes[:'live_applications']
  end

  if attributes.key?(:'sandbox_applications')
    self.sandbox_applications = attributes[:'sandbox_applications']
  end

  if attributes.key?(:'active_campaigns')
    self.active_campaigns = attributes[:'active_campaigns']
  end

  if attributes.key?(:'coupons')
    self.coupons = attributes[:'coupons']
  end

  if attributes.key?(:'referral_codes')
    self.referral_codes = attributes[:'referral_codes']
  end

  if attributes.key?(:'active_rules')
    self.active_rules = attributes[:'active_rules']
  end

  if attributes.key?(:'live_loyalty_programs')
    self.live_loyalty_programs = attributes[:'live_loyalty_programs']
  end

  if attributes.key?(:'sandbox_loyalty_programs')
    self.sandbox_loyalty_programs = attributes[:'sandbox_loyalty_programs']
  end

  if attributes.key?(:'webhooks')
    self.webhooks = attributes[:'webhooks']
  end

  if attributes.key?(:'users')
    self.users = attributes[:'users']
  end

  if attributes.key?(:'api_volume')
    self.api_volume = attributes[:'api_volume']
  end

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

  if attributes.key?(:'secondary_deployment_price')
    self.secondary_deployment_price = attributes[:'secondary_deployment_price']
  end

  if attributes.key?(:'currency_code')
    self.currency_code = attributes[:'currency_code']
  end
end

Instance Attribute Details

#active_campaigns ⇒ Object

Total number of allowed active campaigns in live applications in the account.



24
25
26
 
# File 'lib/talon_one/models/account_limits.rb', line 24

def active_campaigns
  @active_campaigns
end

#active_rules ⇒ Object

Total number of allowed active rulesets in the account.



33
34
35
 
# File 'lib/talon_one/models/account_limits.rb', line 33

def active_rules
  @active_rules
end

#api_volume ⇒ Object

Allowed volume of API requests to the account.



48
49
50
 
# File 'lib/talon_one/models/account_limits.rb', line 48

def api_volume
  @api_volume
end

#coupons ⇒ Object

Total number of allowed coupons in the account.



27
28
29
 
# File 'lib/talon_one/models/account_limits.rb', line 27

def coupons
  @coupons
end

#currency_code ⇒ Object

The currency of the contract.



57
58
59
 
# File 'lib/talon_one/models/account_limits.rb', line 57

def currency_code
  @currency_code
end

#live_applications ⇒ Object

Total number of allowed live applications in the account.



18
19
20
 
# File 'lib/talon_one/models/account_limits.rb', line 18

def live_applications
  @live_applications
end

#live_loyalty_programs ⇒ Object

Total number of allowed live loyalty programs in the account.



36
37
38
 
# File 'lib/talon_one/models/account_limits.rb', line 36

def live_loyalty_programs
  @live_loyalty_programs
end

#promotion_types ⇒ Object

Array of promotion types that are employed in the account.



51
52
53
 
# File 'lib/talon_one/models/account_limits.rb', line 51

def promotion_types
  @promotion_types
end

#referral_codes ⇒ Object

Total number of allowed referral codes in the account.



30
31
32
 
# File 'lib/talon_one/models/account_limits.rb', line 30

def referral_codes
  @referral_codes
end

#sandbox_applications ⇒ Object

Total number of allowed sandbox applications in the account.



21
22
23
 
# File 'lib/talon_one/models/account_limits.rb', line 21

def sandbox_applications
  @sandbox_applications
end

#sandbox_loyalty_programs ⇒ Object

Total number of allowed sandbox loyalty programs in the account.



39
40
41
 
# File 'lib/talon_one/models/account_limits.rb', line 39

def sandbox_loyalty_programs
  @sandbox_loyalty_programs
end

#secondary_deployment_price ⇒ Object

The price for a secondary deployment according to contractual agreements.



54
55
56
 
# File 'lib/talon_one/models/account_limits.rb', line 54

def secondary_deployment_price
  @secondary_deployment_price
end

#users ⇒ Object

Total number of allowed users in the account.



45
46
47
 
# File 'lib/talon_one/models/account_limits.rb', line 45

def users
  @users
end

#webhooks ⇒ Object

Total number of allowed webhooks in the account.



42
43
44
 
# File 'lib/talon_one/models/account_limits.rb', line 42

def webhooks
  @webhooks
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'live_applications' => :'liveApplications',
    :'sandbox_applications' => :'sandboxApplications',
    :'active_campaigns' => :'activeCampaigns',
    :'coupons' => :'coupons',
    :'referral_codes' => :'referralCodes',
    :'active_rules' => :'activeRules',
    :'live_loyalty_programs' => :'liveLoyaltyPrograms',
    :'sandbox_loyalty_programs' => :'sandboxLoyaltyPrograms',
    :'webhooks' => :'webhooks',
    :'users' => :'users',
    :'api_volume' => :'apiVolume',
    :'promotion_types' => :'promotionTypes',
    :'secondary_deployment_price' => :'SecondaryDeploymentPrice',
    :'currency_code' => :'currencyCode'
  }
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



298
299
300
 
# File 'lib/talon_one/models/account_limits.rb', line 298

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
 
# File 'lib/talon_one/models/account_limits.rb', line 100

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'live_applications' => :'Integer',
    :'sandbox_applications' => :'Integer',
    :'active_campaigns' => :'Integer',
    :'coupons' => :'Integer',
    :'referral_codes' => :'Integer',
    :'active_rules' => :'Integer',
    :'live_loyalty_programs' => :'Integer',
    :'sandbox_loyalty_programs' => :'Integer',
    :'webhooks' => :'Integer',
    :'users' => :'Integer',
    :'api_volume' => :'Integer',
    :'promotion_types' => :'Array<String>',
    :'secondary_deployment_price' => :'Integer',
    :'currency_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/talon_one/models/account_limits.rb', line 264

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      live_applications == o.live_applications &&
      sandbox_applications == o.sandbox_applications &&
      active_campaigns == o.active_campaigns &&
      coupons == o.coupons &&
      referral_codes == o.referral_codes &&
      active_rules == o.active_rules &&
      live_loyalty_programs == o.live_loyalty_programs &&
      sandbox_loyalty_programs == o.sandbox_loyalty_programs &&
      webhooks == o.webhooks &&
      users == o.users &&
      api_volume == o.api_volume &&
      promotion_types == o.promotion_types &&
      secondary_deployment_price == o.secondary_deployment_price &&
      currency_code == o.currency_code
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



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
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/talon_one/models/account_limits.rb', line 326

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
    TalonOne.const_get(type).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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/talon_one/models/account_limits.rb', line 395

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/talon_one/models/account_limits.rb', line 305

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


285
286
287
 
# File 'lib/talon_one/models/account_limits.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



291
292
293
 
# File 'lib/talon_one/models/account_limits.rb', line 291

def hash
  [live_applications, sandbox_applications, active_campaigns, coupons, referral_codes, active_rules, live_loyalty_programs, sandbox_loyalty_programs, webhooks, users, api_volume, promotion_types, secondary_deployment_price, currency_code].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



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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/talon_one/models/account_limits.rb', line 181

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

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

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

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

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

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

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

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

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

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

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

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

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

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



371
372
373
 
# File 'lib/talon_one/models/account_limits.rb', line 371

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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/talon_one/models/account_limits.rb', line 377

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



365
366
367
 
# File 'lib/talon_one/models/account_limits.rb', line 365

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



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

def valid?
  return false if @live_applications.nil?
  return false if @sandbox_applications.nil?
  return false if @active_campaigns.nil?
  return false if @coupons.nil?
  return false if @referral_codes.nil?
  return false if @active_rules.nil?
  return false if @live_loyalty_programs.nil?
  return false if @sandbox_loyalty_programs.nil?
  return false if @webhooks.nil?
  return false if @users.nil?
  return false if @api_volume.nil?
  return false if @promotion_types.nil?
  return false if @secondary_deployment_price.nil?
  return false if @currency_code.nil?
  true
end