class OpenapiClient::ConnectDhlEcommerceRequestBody

A DHL Ecommerce account information request body

Attributes

account_number[RW]

Account number

ancillary_endorsement[RW]
api_key[RW]

The DHL E-Commerce API key. This field is optional, but if not set you will not be able to get rates for this account.

api_secret[RW]

The DHL E-Commerce API secret. This field is optional, but if not set you will not be able to get rates for this account.

client_id[RW]

The client id

distribution_center[RW]

The distribution center

ftp_password[RW]

FTP password

ftp_username[RW]

FTP username

nickname[RW]

A nickname to help you identify this account

password[RW]

The account password

pickup_number[RW]

The pickup number

username[RW]

The account username

Public Class Methods

attribute_map() click to toggle source

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

# File lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 54
def self.attribute_map
  {
    :'nickname' => :'nickname',
    :'client_id' => :'client_id',
    :'username' => :'username',
    :'password' => :'password',
    :'pickup_number' => :'pickup_number',
    :'distribution_center' => :'distribution_center',
    :'api_key' => :'api_key',
    :'api_secret' => :'api_secret',
    :'ancillary_endorsement' => :'ancillary_endorsement',
    :'account_number' => :'account_number',
    :'ftp_username' => :'ftp_username',
    :'ftp_password' => :'ftp_password'
  }
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/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 425
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/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 97
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::ConnectDhlEcommerceRequestBody` 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|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::ConnectDhlEcommerceRequestBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 72
def self.openapi_types
  {
    :'nickname' => :'String',
    :'client_id' => :'String',
    :'username' => :'String',
    :'password' => :'String',
    :'pickup_number' => :'String',
    :'distribution_center' => :'String',
    :'api_key' => :'String',
    :'api_secret' => :'String',
    :'ancillary_endorsement' => :'AncillaryServiceEndorsement',
    :'account_number' => :'String',
    :'ftp_username' => :'String',
    :'ftp_password' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 393
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      nickname == o.nickname &&
      client_id == o.client_id &&
      username == o.username &&
      password == o.password &&
      pickup_number == o.pickup_number &&
      distribution_center == o.distribution_center &&
      api_key == o.api_key &&
      api_secret == o.api_secret &&
      ancillary_endorsement == o.ancillary_endorsement &&
      account_number == o.account_number &&
      ftp_username == o.ftp_username &&
      ftp_password == o.ftp_password
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/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 453
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
    OpenapiClient.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/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 522
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_number=(account_number) click to toggle source

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

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

  @account_number = account_number
end
api_key=(api_key) click to toggle source

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

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

  @api_key = api_key
end
api_secret=(api_secret) click to toggle source

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

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

  @api_secret = api_secret
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/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 432
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
client_id=(client_id) click to toggle source

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

# File lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 273
def client_id=(client_id)
  if client_id.nil?
    fail ArgumentError, 'client_id cannot be nil'
  end

  if client_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "client_id", the character length must be great than or equal to 1.'
  end

  @client_id = client_id
end
distribution_center=(distribution_center) click to toggle source

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

# File lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 329
def distribution_center=(distribution_center)
  if distribution_center.nil?
    fail ArgumentError, 'distribution_center cannot be nil'
  end

  if distribution_center.to_s.length < 1
    fail ArgumentError, 'invalid value for "distribution_center", the character length must be great than or equal to 1.'
  end

  @distribution_center = distribution_center
end
eql?(o) click to toggle source

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

# File lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 412
def eql?(o)
  self == o
end
ftp_password=(ftp_password) click to toggle source

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

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

  @ftp_password = ftp_password
end
ftp_username=(ftp_username) click to toggle source

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

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

  @ftp_username = ftp_username
end
hash() click to toggle source

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

# File lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 418
def hash
  [nickname, client_id, username, password, pickup_number, distribution_center, api_key, api_secret, ancillary_endorsement, account_number, ftp_username, ftp_password].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/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 161
def list_invalid_properties
  invalid_properties = Array.new
  if @nickname.nil?
    invalid_properties.push('invalid value for "nickname", nickname cannot be nil.')
  end

  if @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 @client_id.nil?
    invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
  end

  if @client_id.to_s.length < 1
    invalid_properties.push('invalid value for "client_id", the character length must be great than or equal to 1.')
  end

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

  if @username.to_s.length < 1
    invalid_properties.push('invalid value for "username", the character length must be great than or equal to 1.')
  end

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

  if @password.to_s.length < 1
    invalid_properties.push('invalid value for "password", the character length must be great than or equal to 1.')
  end

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

  if @pickup_number.to_s.length < 1
    invalid_properties.push('invalid value for "pickup_number", the character length must be great than or equal to 1.')
  end

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

  if @distribution_center.to_s.length < 1
    invalid_properties.push('invalid value for "distribution_center", the character length must be great than or equal to 1.')
  end

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

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

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

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

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

  invalid_properties
end
nickname=(nickname) click to toggle source

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

# File lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 259
def nickname=(nickname)
  if nickname.nil?
    fail ArgumentError, 'nickname cannot be nil'
  end

  if 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
password=(password) click to toggle source

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

# File lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 301
def password=(password)
  if password.nil?
    fail ArgumentError, 'password cannot be nil'
  end

  if password.to_s.length < 1
    fail ArgumentError, 'invalid value for "password", the character length must be great than or equal to 1.'
  end

  @password = password
end
pickup_number=(pickup_number) click to toggle source

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

# File lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 315
def pickup_number=(pickup_number)
  if pickup_number.nil?
    fail ArgumentError, 'pickup_number cannot be nil'
  end

  if pickup_number.to_s.length < 1
    fail ArgumentError, 'invalid value for "pickup_number", the character length must be great than or equal to 1.'
  end

  @pickup_number = pickup_number
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/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 498
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/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 504
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/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 492
def to_s
  to_hash.to_s
end
username=(username) click to toggle source

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

# File lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 287
def username=(username)
  if username.nil?
    fail ArgumentError, 'username cannot be nil'
  end

  if username.to_s.length < 1
    fail ArgumentError, 'invalid value for "username", the character length must be great than or equal to 1.'
  end

  @username = username
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/openapi_client/models/connect_dhl_ecommerce_request_body.rb, line 236
def valid?
  return false if @nickname.nil?
  return false if @nickname.to_s.length < 1
  return false if @client_id.nil?
  return false if @client_id.to_s.length < 1
  return false if @username.nil?
  return false if @username.to_s.length < 1
  return false if @password.nil?
  return false if @password.to_s.length < 1
  return false if @pickup_number.nil?
  return false if @pickup_number.to_s.length < 1
  return false if @distribution_center.nil?
  return false if @distribution_center.to_s.length < 1
  return false if !@api_key.nil? && @api_key.to_s.length < 1
  return false if !@api_secret.nil? && @api_secret.to_s.length < 1
  return false if !@account_number.nil? && @account_number.to_s.length < 1
  return false if !@ftp_username.nil? && @ftp_username.to_s.length < 1
  return false if !@ftp_password.nil? && @ftp_password.to_s.length < 1
  true
end