class SibApiV3Sdk::GetAccountPlan

Attributes

credits[RW]

Remaining credits of the user

credits_type[RW]

This is the type of the credit, "Send Limit" is one of the possible types of credit of a user. "Send Limit" implies the total number of emails you can send to the subscribers in your account.

end_date[RW]

Date of the period from which the plan will end (only available for "subscription" and "reseller" plan type)

start_date[RW]

Date of the period from which the plan will start (only available for "subscription" and "reseller" plan type)

type[RW]

Displays the plan type of the user

user_limit[RW]

Only in case of reseller account. It implies the total number of child accounts you can add to your account.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_account_plan.rb, line 58
def self.attribute_map
  {
    :'type' => :'type',
    :'credits_type' => :'creditsType',
    :'credits' => :'credits',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'user_limit' => :'userLimit'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_account_plan.rb, line 83
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?(:'type')
    self.type = attributes[:'type']
  end

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

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

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

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

  if attributes.has_key?(:'userLimit')
    self.user_limit = attributes[:'userLimit']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/sib-api-v3-sdk/models/get_account_plan.rb, line 70
def self.swagger_types
  {
    :'type' => :'String',
    :'credits_type' => :'String',
    :'credits' => :'Float',
    :'start_date' => :'Date',
    :'end_date' => :'Date',
    :'user_limit' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_account_plan.rb, line 168
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      credits_type == o.credits_type &&
      credits == o.credits &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      user_limit == o.user_limit
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/sib-api-v3-sdk/models/get_account_plan.rb, line 215
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 = SibApiV3Sdk.const_get(type).new
    temp_model.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/sib-api-v3-sdk/models/get_account_plan.rb, line 281
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/sib-api-v3-sdk/models/get_account_plan.rb, line 194
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
credits_type=(credits_type) click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_account_plan.rb, line 158
def credits_type=(credits_type)
  validator = EnumAttributeValidator.new('String', ['sendLimit'])
  unless validator.valid?(credits_type)
    fail ArgumentError, 'invalid value for "credits_type", must be one of #{validator.allowable_values}.'
  end
  @credits_type = credits_type
end
eql?(o) click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_account_plan.rb, line 181
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_account_plan.rb, line 187
def hash
  [type, credits_type, credits, start_date, end_date, user_limit].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/sib-api-v3-sdk/models/get_account_plan.rb, line 116
def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

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

  if @credits.nil?
    invalid_properties.push('invalid value for "credits", credits 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/sib-api-v3-sdk/models/get_account_plan.rb, line 261
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/sib-api-v3-sdk/models/get_account_plan.rb, line 267
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() click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_account_plan.rb, line 255
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

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

# File lib/sib-api-v3-sdk/models/get_account_plan.rb, line 148
def type=(type)
  validator = EnumAttributeValidator.new('String', ['payAsYouGo', 'free', 'subscription', 'sms', 'reseller'])
  unless validator.valid?(type)
    fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
  end
  @type = type
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/sib-api-v3-sdk/models/get_account_plan.rb, line 135
def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ['payAsYouGo', 'free', 'subscription', 'sms', 'reseller'])
  return false unless type_validator.valid?(@type)
  return false if @credits_type.nil?
  credits_type_validator = EnumAttributeValidator.new('String', ['sendLimit'])
  return false unless credits_type_validator.valid?(@credits_type)
  return false if @credits.nil?
  true
end