class UltracartClient::OrderFormat

Attributes

context[RW]

The context to generate the order view for.

filter_distribution_center_oid[RW]

Specify a distribution center oid to filter the items displayed to that particular distribution center.

filter_to_items_in_contact_oid[RW]

The container oid to filter items to.

format[RW]

The desired format.

hide_bill_to_address[RW]

True to ide the bill to address

hide_price_information[RW]

True to hide price information

show_contact_info[RW]

True to show contact information

show_in_merchant_currency[RW]

True to show the order in the merchant currency

show_internal_information[RW]

True to show internal information about the order

show_merchant_notes[RW]

True to show merchant notes

show_non_sensitive_payment_info[RW]

True to show non-sensitive payment information

show_payment_info[RW]

True to show payment information

translate[RW]

True to translate the order into the native language of the customer

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_format.rb, line 88
def self.attribute_map
  {
    :'context' => :'context',
    :'dont_link_email_to_search' => :'dont_link_email_to_search',
    :'email_as_link' => :'email_as_link',
    :'filter_distribution_center_oid' => :'filter_distribution_center_oid',
    :'filter_to_items_in_contact_oid' => :'filter_to_items_in_contact_oid',
    :'format' => :'format',
    :'hide_bill_to_address' => :'hide_bill_to_address',
    :'hide_price_information' => :'hide_price_information',
    :'link_file_attachments' => :'link_file_attachments',
    :'show_contact_info' => :'show_contact_info',
    :'show_in_merchant_currency' => :'show_in_merchant_currency',
    :'show_internal_information' => :'show_internal_information',
    :'show_merchant_notes' => :'show_merchant_notes',
    :'show_non_sensitive_payment_info' => :'show_non_sensitive_payment_info',
    :'show_payment_info' => :'show_payment_info',
    :'translate' => :'translate'
  }
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_format.rb, line 133
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?(:'context')
    self.context = attributes[:'context']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/order_format.rb, line 110
def self.swagger_types
  {
    :'context' => :'String',
    :'dont_link_email_to_search' => :'BOOLEAN',
    :'email_as_link' => :'BOOLEAN',
    :'filter_distribution_center_oid' => :'Integer',
    :'filter_to_items_in_contact_oid' => :'Integer',
    :'format' => :'String',
    :'hide_bill_to_address' => :'BOOLEAN',
    :'hide_price_information' => :'BOOLEAN',
    :'link_file_attachments' => :'BOOLEAN',
    :'show_contact_info' => :'BOOLEAN',
    :'show_in_merchant_currency' => :'BOOLEAN',
    :'show_internal_information' => :'BOOLEAN',
    :'show_merchant_notes' => :'BOOLEAN',
    :'show_non_sensitive_payment_info' => :'BOOLEAN',
    :'show_payment_info' => :'BOOLEAN',
    :'translate' => :'BOOLEAN'
  }
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_format.rb, line 231
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      context == o.context &&
      dont_link_email_to_search == o.dont_link_email_to_search &&
      email_as_link == o.email_as_link &&
      filter_distribution_center_oid == o.filter_distribution_center_oid &&
      filter_to_items_in_contact_oid == o.filter_to_items_in_contact_oid &&
      format == o.format &&
      hide_bill_to_address == o.hide_bill_to_address &&
      hide_price_information == o.hide_price_information &&
      link_file_attachments == o.link_file_attachments &&
      show_contact_info == o.show_contact_info &&
      show_in_merchant_currency == o.show_in_merchant_currency &&
      show_internal_information == o.show_internal_information &&
      show_merchant_notes == o.show_merchant_notes &&
      show_non_sensitive_payment_info == o.show_non_sensitive_payment_info &&
      show_payment_info == o.show_payment_info &&
      translate == o.translate
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_format.rb, line 288
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_format.rb, line 354
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_format.rb, line 267
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_format.rb, line 254
def eql?(o)
  self == o
end
format=(format) click to toggle source

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

# File lib/ultracart_api/models/order_format.rb, line 221
def format=(format)
  validator = EnumAttributeValidator.new('String', ['text', 'div', 'table', 'email'])
  unless validator.valid?(format)
    fail ArgumentError, 'invalid value for "format", must be one of #{validator.allowable_values}.'
  end
  @format = format
end
hash() click to toggle source

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

# File lib/ultracart_api/models/order_format.rb, line 260
def hash
  [context, dont_link_email_to_search, email_as_link, filter_distribution_center_oid, filter_to_items_in_contact_oid, format, hide_bill_to_address, hide_price_information, link_file_attachments, show_contact_info, show_in_merchant_currency, show_internal_information, show_merchant_notes, show_non_sensitive_payment_info, show_payment_info, translate].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_format.rb, line 206
def list_invalid_properties
  invalid_properties = Array.new
  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/ultracart_api/models/order_format.rb, line 334
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_format.rb, line 340
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_format.rb, line 328
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_format.rb, line 213
def valid?
  format_validator = EnumAttributeValidator.new('String', ['text', 'div', 'table', 'email'])
  return false unless format_validator.valid?(@format)
  true
end