class TalonOne::AccountLimits

Attributes

active_campaigns[RW]

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

active_rules[RW]

Total number of allowed active rulesets in the account

api_volume[RW]

Allowed volume of API requests to the account

coupons[RW]

Total number of allowed coupons in the account

live_applications[RW]

Total number of allowed live applications in the account

live_loyalty_programs[RW]

Total number of allowed live loyalty programs in the account

promotion_types[RW]

Array of promotion types that are employed in the account

referral_codes[RW]

Total number of allowed referral codes in the account

sandbox_applications[RW]

Total number of allowed sandbox applications in the account

sandbox_loyalty_programs[RW]

Total number of allowed sandbox loyalty programs in the account

users[RW]

Total number of allowed users in the account

webhooks[RW]

Total number of allowed webhooks in the account

Public Class Methods

attribute_map() click to toggle source

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

# File lib/talon_one/models/account_limits.rb, line 54
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'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/talon_one/models/account_limits.rb, line 268
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/talon_one/models/account_limits.rb, line 97
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
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/talon_one/models/account_limits.rb, line 90
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/talon_one/models/account_limits.rb, line 72
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>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/talon_one/models/account_limits.rb, line 236
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
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/talon_one/models/account_limits.rb, line 296
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/talon_one/models/account_limits.rb, line 365
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/talon_one/models/account_limits.rb, line 275
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/talon_one/models/account_limits.rb, line 255
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/talon_one/models/account_limits.rb, line 261
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].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/talon_one/models/account_limits.rb, line 163
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

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/talon_one/models/account_limits.rb, line 341
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/talon_one/models/account_limits.rb, line 347
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/talon_one/models/account_limits.rb, line 335
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/talon_one/models/account_limits.rb, line 218
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?
  true
end