class UltracartClient::OrderAutoOrder

Attributes

auto_order_code[RW]

Unique code assigned to this auto order

auto_order_oid[RW]

Auto order object identifier

cancel_after_next_x_orders[RW]

Cancel this auto order after X additional rebills

cancel_downgrade[RW]

True if the auto order was canceled because the customer purchased a downgrade item

cancel_upgrade[RW]

True if the auto order was canceled because the customer purchased an upgrade item

canceled_by_user[RW]

The user that canceled the auto order

canceled_dts[RW]

The date/time that the auto order was canceled

completed[RW]

True if the auto order ran successfully to completion

credit_card_attempt[RW]

The number of credit card attempts that have taken place

disabled_dts[RW]

The date/time the auto order was disabled due to failed rebills

enabled[RW]

True if this auto order is enabled

failure_reason[RW]

The reason this auto order failed during the last rebill attempt

items[RW]

The items that are setup to rebill

next_attempt[RW]

The next time that the auto order will be attempted for processing

original_order_id[RW]

The original order id that this auto order is associated with.

override_affiliate_id[RW]

Override the affiliate id given credit for rebills of this auto order

rebill_orders[RW]

Rebill orders that have taken place on this auto order

rotating_transaction_gateway_code[RW]

The RTG code associated with this order for future rebills

status[RW]

The status of the auto order

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/order_auto_order.rb, line 97
def self.attribute_map
  {
    :'auto_order_code' => :'auto_order_code',
    :'auto_order_oid' => :'auto_order_oid',
    :'cancel_after_next_x_orders' => :'cancel_after_next_x_orders',
    :'cancel_downgrade' => :'cancel_downgrade',
    :'cancel_upgrade' => :'cancel_upgrade',
    :'canceled_by_user' => :'canceled_by_user',
    :'canceled_dts' => :'canceled_dts',
    :'completed' => :'completed',
    :'credit_card_attempt' => :'credit_card_attempt',
    :'disabled_dts' => :'disabled_dts',
    :'enabled' => :'enabled',
    :'failure_reason' => :'failure_reason',
    :'items' => :'items',
    :'next_attempt' => :'next_attempt',
    :'original_order_id' => :'original_order_id',
    :'override_affiliate_id' => :'override_affiliate_id',
    :'rebill_orders' => :'rebill_orders',
    :'rotating_transaction_gateway_code' => :'rotating_transaction_gateway_code',
    :'status' => :'status'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/ultracart_api/models/order_auto_order.rb, line 148
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?(:'auto_order_code')
    self.auto_order_code = attributes[:'auto_order_code']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/order_auto_order.rb, line 122
def self.swagger_types
  {
    :'auto_order_code' => :'String',
    :'auto_order_oid' => :'Integer',
    :'cancel_after_next_x_orders' => :'Integer',
    :'cancel_downgrade' => :'BOOLEAN',
    :'cancel_upgrade' => :'BOOLEAN',
    :'canceled_by_user' => :'String',
    :'canceled_dts' => :'String',
    :'completed' => :'BOOLEAN',
    :'credit_card_attempt' => :'Integer',
    :'disabled_dts' => :'String',
    :'enabled' => :'BOOLEAN',
    :'failure_reason' => :'String',
    :'items' => :'Array<AutoOrderItem>',
    :'next_attempt' => :'String',
    :'original_order_id' => :'String',
    :'override_affiliate_id' => :'Integer',
    :'rebill_orders' => :'Array<Order>',
    :'rotating_transaction_gateway_code' => :'String',
    :'status' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ultracart_api/models/order_auto_order.rb, line 262
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auto_order_code == o.auto_order_code &&
      auto_order_oid == o.auto_order_oid &&
      cancel_after_next_x_orders == o.cancel_after_next_x_orders &&
      cancel_downgrade == o.cancel_downgrade &&
      cancel_upgrade == o.cancel_upgrade &&
      canceled_by_user == o.canceled_by_user &&
      canceled_dts == o.canceled_dts &&
      completed == o.completed &&
      credit_card_attempt == o.credit_card_attempt &&
      disabled_dts == o.disabled_dts &&
      enabled == o.enabled &&
      failure_reason == o.failure_reason &&
      items == o.items &&
      next_attempt == o.next_attempt &&
      original_order_id == o.original_order_id &&
      override_affiliate_id == o.override_affiliate_id &&
      rebill_orders == o.rebill_orders &&
      rotating_transaction_gateway_code == o.rotating_transaction_gateway_code &&
      status == o.status
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/ultracart_api/models/order_auto_order.rb, line 322
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 = UltracartClient.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/ultracart_api/models/order_auto_order.rb, line 388
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/ultracart_api/models/order_auto_order.rb, line 301
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
eql?(o) click to toggle source

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

# File lib/ultracart_api/models/order_auto_order.rb, line 288
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ultracart_api/models/order_auto_order.rb, line 294
def hash
  [auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, next_attempt, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].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/ultracart_api/models/order_auto_order.rb, line 237
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
status=(status) click to toggle source

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

# File lib/ultracart_api/models/order_auto_order.rb, line 252
def status=(status)
  validator = EnumAttributeValidator.new('String', ['active', 'canceled', 'disabled'])
  unless validator.valid?(status)
    fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
  end
  @status = status
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/ultracart_api/models/order_auto_order.rb, line 368
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/ultracart_api/models/order_auto_order.rb, line 374
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/ultracart_api/models/order_auto_order.rb, line 362
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/ultracart_api/models/order_auto_order.rb, line 244
def valid?
  status_validator = EnumAttributeValidator.new('String', ['active', 'canceled', 'disabled'])
  return false unless status_validator.valid?(@status)
  true
end