class Bfwd::CouponDefinition

A coupon-definition.

Attributes

changed_by[RW]

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

created[RW]

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

crm_id[RW]

{ "description" : "CRM ID of the product-rate-plan.", "verbs":["POST","PUT","GET"] }

currency[RW]

{ "description" : "The currency of the coupon-definition specified by a three character ISO 4217 currency code.", "verbs":["POST","PUT","GET"] }

customer_code[RW]

{ "description" : "The customerCode associated with the organization.", "verbs":["POST","PUT","GET"] }

definition_valid_from[RW]

{ "description" : "The UTC DateTime that the coupon-definition is valid from.", "verbs":["POST","PUT","GET"] }

definition_valid_till[RW]

{ "description" : "The UTC DateTime that the coupon-definition is valid until.", "verbs":["POST","PUT","GET"] }

description[RW]

{ "description" : "The human readable description of the coupon-definition.", "verbs":["POST","PUT","GET"] }

fixed_end_date[RW]

{ "description" : "The UTC DateTime specifying the fixed end date of the coupon-definition.", "verbs":["POST","PUT","GET"] }

id[RW]

{ "description" : "ID of the coupon-definition.", "verbs":["POST","PUT","GET"] }

instance_duration[RW]

{ "description" : "instanceDuration", "verbs":["POST","PUT","GET"] }

instance_duration_period[RW]

{ "description" : "instanceDurationPeriod", "verbs":["POST","PUT","GET"] }

modifiers[RW]

{ "description" : "The collection of coupon-modifiers associated with the coupon-definition.", "verbs":["POST","PUT","GET"] }

name[RW]

{ "description" : "The human readable name of the coupon-definition.", "verbs":["POST","PUT","GET"] }

organization_id[RW]

{ "description" : "ID of the organization associated with the coupon-definition.", "verbs":["POST","PUT","GET"] }

rules[RW]

{ "description" : "The collection of coupon-rules associated with the coupon-definition.", "verbs":["POST","PUT","GET"] }

state[RW]

{ "description" : "The current state of the coupon-definition.", "verbs":["POST","PUT","GET"] }

target[RW]

{ "description" : "The target of the coupon-definition. Currently coupon-definitions can only target products.", "verbs":["POST","PUT","GET"] }

updated[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# File lib/bf_ruby2/models/coupon_definition.rb, line 98
def self.attribute_map
  {
    :'created' => :'created',
    :'changed_by' => :'changedBy',
    :'updated' => :'updated',
    :'id' => :'id',
    :'crm_id' => :'crmID',
    :'organization_id' => :'organizationID',
    :'name' => :'name',
    :'description' => :'description',
    :'customer_code' => :'customerCode',
    :'target' => :'target',
    :'currency' => :'currency',
    :'definition_valid_from' => :'definitionValidFrom',
    :'definition_valid_till' => :'definitionValidTill',
    :'instance_duration_period' => :'instanceDurationPeriod',
    :'instance_duration' => :'instanceDuration',
    :'fixed_end_date' => :'fixedEndDate',
    :'state' => :'state',
    :'modifiers' => :'modifiers',
    :'rules' => :'rules'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/bf_ruby2/models/coupon_definition.rb, line 149
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?(:'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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/bf_ruby2/models/coupon_definition.rb, line 123
def self.swagger_types
  {
    :'created' => :'DateTime',
    :'changed_by' => :'String',
    :'updated' => :'DateTime',
    :'id' => :'String',
    :'crm_id' => :'String',
    :'organization_id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'customer_code' => :'String',
    :'target' => :'String',
    :'currency' => :'String',
    :'definition_valid_from' => :'DateTime',
    :'definition_valid_till' => :'DateTime',
    :'instance_duration_period' => :'String',
    :'instance_duration' => :'Integer',
    :'fixed_end_date' => :'DateTime',
    :'state' => :'String',
    :'modifiers' => :'Array<CouponModifierBase>',
    :'rules' => :'Array<CouponRule>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/bf_ruby2/models/coupon_definition.rb, line 353
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      changed_by == o.changed_by &&
      updated == o.updated &&
      id == o.id &&
      crm_id == o.crm_id &&
      organization_id == o.organization_id &&
      name == o.name &&
      description == o.description &&
      customer_code == o.customer_code &&
      target == o.target &&
      currency == o.currency &&
      definition_valid_from == o.definition_valid_from &&
      definition_valid_till == o.definition_valid_till &&
      instance_duration_period == o.instance_duration_period &&
      instance_duration == o.instance_duration &&
      fixed_end_date == o.fixed_end_date &&
      state == o.state &&
      modifiers == o.modifiers &&
      rules == o.rules
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/bf_ruby2/models/coupon_definition.rb, line 413
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) 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/bf_ruby2/models/coupon_definition.rb, line 479
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/bf_ruby2/models/coupon_definition.rb, line 392
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) click to toggle source

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

# File lib/bf_ruby2/models/coupon_definition.rb, line 379
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/bf_ruby2/models/coupon_definition.rb, line 385
def hash
  [created, changed_by, updated, id, crm_id, organization_id, name, description, customer_code, target, currency, definition_valid_from, definition_valid_till, instance_duration_period, instance_duration, fixed_end_date, state, modifiers, rules].hash
end
instance_duration_period=(instance_duration_period) click to toggle source

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

# File lib/bf_ruby2/models/coupon_definition.rb, line 333
def instance_duration_period=(instance_duration_period)
  validator = EnumAttributeValidator.new('String', ["minutes", "hours", "days", "months", "years", "periods"])
  unless validator.valid?(instance_duration_period)
    fail ArgumentError, "invalid value for 'instance_duration_period', must be one of #{validator.allowable_values}."
  end
  @instance_duration_period = instance_duration_period
end
list_invalid_properties() click to toggle source

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

# File lib/bf_ruby2/models/coupon_definition.rb, line 239
def list_invalid_properties
  invalid_properties = Array.new
  if @crm_id.nil?
    invalid_properties.push("invalid value for 'crm_id', crm_id cannot be nil.")
  end

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

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

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

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

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

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

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

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

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

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

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

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

  return 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/bf_ruby2/models/coupon_definition.rb, line 343
def state=(state)
  validator = EnumAttributeValidator.new('String', ["development", "production", "deleted"])
  unless validator.valid?(state)
    fail ArgumentError, "invalid value for 'state', must be one of #{validator.allowable_values}."
  end
  @state = state
end
target=(target) click to toggle source

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

# File lib/bf_ruby2/models/coupon_definition.rb, line 323
def target=(target)
  validator = EnumAttributeValidator.new('String', ["product", "account"])
  unless validator.valid?(target)
    fail ArgumentError, "invalid value for 'target', must be one of #{validator.allowable_values}."
  end
  @target = target
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/bf_ruby2/models/coupon_definition.rb, line 459
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/bf_ruby2/models/coupon_definition.rb, line 465
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/bf_ruby2/models/coupon_definition.rb, line 453
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/bf_ruby2/models/coupon_definition.rb, line 298
def valid?
  return false if @crm_id.nil?
  return false if @organization_id.nil?
  return false if @name.nil?
  return false if @description.nil?
  return false if @customer_code.nil?
  return false if @target.nil?
  target_validator = EnumAttributeValidator.new('String', ["product", "account"])
  return false unless target_validator.valid?(@target)
  return false if @currency.nil?
  return false if @definition_valid_from.nil?
  return false if @instance_duration_period.nil?
  instance_duration_period_validator = EnumAttributeValidator.new('String', ["minutes", "hours", "days", "months", "years", "periods"])
  return false unless instance_duration_period_validator.valid?(@instance_duration_period)
  return false if @instance_duration.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["development", "production", "deleted"])
  return false unless state_validator.valid?(@state)
  return false if @modifiers.nil?
  return false if @rules.nil?
  return true
end