class TalonOne::Account

Attributes

api_limit[RW]

The maximum number of Integration API calls covered by your plan per billing period.

application_count[RW]

The current number of Applications in your account.

application_limit[RW]

The maximum number of Applications covered by your plan.

attributes[RW]

Arbitrary properties associated with this campaign

billing_email[RW]

The billing email address associated with your company account.

campaign_limit[RW]

The maximum number of Campaigns covered by your plan.

campaigns_active_count[RW]

The current number of active Campaigns in your account.

campaigns_inactive_count[RW]

The current number of inactive Campaigns in your account.

company_name[RW]
created[RW]

The exact moment this entity was created.

domain_name[RW]

Subdomain Name for yourcompany.talon.one

id[RW]

Unique ID for this entity.

modified[RW]

The exact moment this entity was last modified.

plan_expires[RW]

The point in time at which your current plan expires.

plan_name[RW]

The name of your booked plan.

state[RW]

State of the account (active, deactivated)

user_count[RW]

The current number of Campaign Manager Users in your account.

user_limit[RW]

The maximum number of Campaign Manager Users covered by your plan.

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.rb, line 94
def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'modified' => :'modified',
    :'company_name' => :'companyName',
    :'domain_name' => :'domainName',
    :'state' => :'state',
    :'billing_email' => :'billingEmail',
    :'plan_name' => :'planName',
    :'plan_expires' => :'planExpires',
    :'application_limit' => :'applicationLimit',
    :'user_limit' => :'userLimit',
    :'campaign_limit' => :'campaignLimit',
    :'api_limit' => :'apiLimit',
    :'application_count' => :'applicationCount',
    :'user_count' => :'userCount',
    :'campaigns_active_count' => :'campaignsActiveCount',
    :'campaigns_inactive_count' => :'campaignsInactiveCount',
    :'attributes' => :'attributes'
  }
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.rb, line 374
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.rb, line 149
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::Account` 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::Account`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'attributes')
    self.attributes = attributes[:'attributes']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/talon_one/models/account.rb, line 118
def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'modified' => :'DateTime',
    :'company_name' => :'String',
    :'domain_name' => :'String',
    :'state' => :'String',
    :'billing_email' => :'String',
    :'plan_name' => :'String',
    :'plan_expires' => :'DateTime',
    :'application_limit' => :'Integer',
    :'user_limit' => :'Integer',
    :'campaign_limit' => :'Integer',
    :'api_limit' => :'Integer',
    :'application_count' => :'Integer',
    :'user_count' => :'Integer',
    :'campaigns_active_count' => :'Integer',
    :'campaigns_inactive_count' => :'Integer',
    :'attributes' => :'Object'
  }
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.rb, line 336
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      modified == o.modified &&
      company_name == o.company_name &&
      domain_name == o.domain_name &&
      state == o.state &&
      billing_email == o.billing_email &&
      plan_name == o.plan_name &&
      plan_expires == o.plan_expires &&
      application_limit == o.application_limit &&
      user_limit == o.user_limit &&
      campaign_limit == o.campaign_limit &&
      api_limit == o.api_limit &&
      application_count == o.application_count &&
      user_count == o.user_count &&
      campaigns_active_count == o.campaigns_active_count &&
      campaigns_inactive_count == o.campaigns_inactive_count &&
      attributes == o.attributes
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.rb, line 402
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.rb, line 471
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.rb, line 381
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
company_name=(company_name) click to toggle source

Custom attribute writer method with validation @param [Object] company_name Value to be assigned

# File lib/talon_one/models/account.rb, line 312
def company_name=(company_name)
  if company_name.nil?
    fail ArgumentError, 'company_name cannot be nil'
  end

  if company_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_name", the character length must be great than or equal to 1.'
  end

  @company_name = company_name
end
eql?(o) click to toggle source

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

# File lib/talon_one/models/account.rb, line 361
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.rb, line 367
def hash
  [id, created, modified, company_name, domain_name, state, billing_email, plan_name, plan_expires, application_limit, user_limit, campaign_limit, api_limit, application_count, user_count, campaigns_active_count, campaigns_inactive_count, attributes].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.rb, line 237
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

  if @company_name.to_s.length < 1
    invalid_properties.push('invalid value for "company_name", the character length must be great than or equal to 1.')
  end

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

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

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

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

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

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

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

  invalid_properties
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/talon_one/models/account.rb, line 326
def state=(state)
  validator = EnumAttributeValidator.new('String', ["active", "deactivated"])
  unless validator.valid?(state)
    fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
  end
  @state = state
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.rb, line 447
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.rb, line 453
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.rb, line 441
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.rb, line 292
def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @modified.nil?
  return false if @company_name.nil?
  return false if @company_name.to_s.length < 1
  return false if @domain_name.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["active", "deactivated"])
  return false unless state_validator.valid?(@state)
  return false if @billing_email.nil?
  return false if @application_count.nil?
  return false if @user_count.nil?
  return false if @campaigns_active_count.nil?
  return false if @campaigns_inactive_count.nil?
  true
end