class ShipEngine::UpsAccountSettings

UPS account settings

Attributes

account_postal_code[RW]

account postal code

invoice[RW]

The invoice

is_primary_account[RW]

Indicates if this is the primary UPS account

mail_innovations_cost_center[RW]

mail innovations cost center

mail_innovations_endorsement[RW]
nickname[RW]

nickname

pickup_type[RW]
use_carbon_neutral_shipping_program[RW]

The use carbon neutral shipping program

use_consolidation_services[RW]

The use consolidation services

use_ground_freight_pricing[RW]

The use ground freight pricing

use_negotiated_rates[RW]

The use negotiated rates

use_order_number_on_mail_innovations_labels[RW]

The use order number on mail innovations labels

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ship_engine/models/ups_account_settings.rb, line 53
def self.attribute_map
  {
    :'nickname' => :'nickname',
    :'is_primary_account' => :'is_primary_account',
    :'pickup_type' => :'pickup_type',
    :'use_carbon_neutral_shipping_program' => :'use_carbon_neutral_shipping_program',
    :'use_ground_freight_pricing' => :'use_ground_freight_pricing',
    :'use_consolidation_services' => :'use_consolidation_services',
    :'use_order_number_on_mail_innovations_labels' => :'use_order_number_on_mail_innovations_labels',
    :'mail_innovations_endorsement' => :'mail_innovations_endorsement',
    :'mail_innovations_cost_center' => :'mail_innovations_cost_center',
    :'use_negotiated_rates' => :'use_negotiated_rates',
    :'account_postal_code' => :'account_postal_code',
    :'invoice' => :'invoice'
  }
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/ship_engine/models/ups_account_settings.rb, line 248
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/ship_engine/models/ups_account_settings.rb, line 96
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::UpsAccountSettings` 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|

    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/ship_engine/models/ups_account_settings.rb, line 71
def self.openapi_types
  {
    :'nickname' => :'String',
    :'is_primary_account' => :'Boolean',
    :'pickup_type' => :'UpsPickupType',
    :'use_carbon_neutral_shipping_program' => :'Boolean',
    :'use_ground_freight_pricing' => :'Boolean',
    :'use_consolidation_services' => :'Boolean',
    :'use_order_number_on_mail_innovations_labels' => :'Boolean',
    :'mail_innovations_endorsement' => :'AncillaryServiceEndorsement',
    :'mail_innovations_cost_center' => :'String',
    :'use_negotiated_rates' => :'Boolean',
    :'account_postal_code' => :'String',
    :'invoice' => :'UpsInvoice'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ship_engine/models/ups_account_settings.rb, line 216
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      nickname == o.nickname &&
      is_primary_account == o.is_primary_account &&
      pickup_type == o.pickup_type &&
      use_carbon_neutral_shipping_program == o.use_carbon_neutral_shipping_program &&
      use_ground_freight_pricing == o.use_ground_freight_pricing &&
      use_consolidation_services == o.use_consolidation_services &&
      use_order_number_on_mail_innovations_labels == o.use_order_number_on_mail_innovations_labels &&
      mail_innovations_endorsement == o.mail_innovations_endorsement &&
      mail_innovations_cost_center == o.mail_innovations_cost_center &&
      use_negotiated_rates == o.use_negotiated_rates &&
      account_postal_code == o.account_postal_code &&
      invoice == o.invoice
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/ship_engine/models/ups_account_settings.rb, line 276
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
    ShipEngine.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/ship_engine/models/ups_account_settings.rb, line 345
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
account_postal_code=(account_postal_code) click to toggle source

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

# File lib/ship_engine/models/ups_account_settings.rb, line 206
def account_postal_code=(account_postal_code)
  if !account_postal_code.nil? && account_postal_code.to_s.length < 5
    fail ArgumentError, 'invalid value for "account_postal_code", the character length must be great than or equal to 5.'
  end

  @account_postal_code = account_postal_code
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/ship_engine/models/ups_account_settings.rb, line 255
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
eql?(o) click to toggle source

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

# File lib/ship_engine/models/ups_account_settings.rb, line 235
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ship_engine/models/ups_account_settings.rb, line 241
def hash
  [nickname, is_primary_account, pickup_type, use_carbon_neutral_shipping_program, use_ground_freight_pricing, use_consolidation_services, use_order_number_on_mail_innovations_labels, mail_innovations_endorsement, mail_innovations_cost_center, use_negotiated_rates, account_postal_code, invoice].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/ship_engine/models/ups_account_settings.rb, line 158
def list_invalid_properties
  invalid_properties = Array.new
  if !@nickname.nil? && @nickname.to_s.length < 1
    invalid_properties.push('invalid value for "nickname", the character length must be great than or equal to 1.')
  end

  if !@mail_innovations_cost_center.nil? && @mail_innovations_cost_center.to_s.length < 0
    invalid_properties.push('invalid value for "mail_innovations_cost_center", the character length must be great than or equal to 0.')
  end

  if !@account_postal_code.nil? && @account_postal_code.to_s.length < 5
    invalid_properties.push('invalid value for "account_postal_code", the character length must be great than or equal to 5.')
  end

  invalid_properties
end
mail_innovations_cost_center=(mail_innovations_cost_center) click to toggle source

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

# File lib/ship_engine/models/ups_account_settings.rb, line 196
def mail_innovations_cost_center=(mail_innovations_cost_center)
  if !mail_innovations_cost_center.nil? && mail_innovations_cost_center.to_s.length < 0
    fail ArgumentError, 'invalid value for "mail_innovations_cost_center", the character length must be great than or equal to 0.'
  end

  @mail_innovations_cost_center = mail_innovations_cost_center
end
nickname=(nickname) click to toggle source

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

# File lib/ship_engine/models/ups_account_settings.rb, line 186
def nickname=(nickname)
  if !nickname.nil? && nickname.to_s.length < 1
    fail ArgumentError, 'invalid value for "nickname", the character length must be great than or equal to 1.'
  end

  @nickname = nickname
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/ship_engine/models/ups_account_settings.rb, line 321
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/ship_engine/models/ups_account_settings.rb, line 327
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/ship_engine/models/ups_account_settings.rb, line 315
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/ship_engine/models/ups_account_settings.rb, line 177
def valid?
  return false if !@nickname.nil? && @nickname.to_s.length < 1
  return false if !@mail_innovations_cost_center.nil? && @mail_innovations_cost_center.to_s.length < 0
  return false if !@account_postal_code.nil? && @account_postal_code.to_s.length < 5
  true
end