class DocuSign_eSign::PaymentGatewayAccount

This object contains details about a payment gateway account.

Attributes

allow_custom_metadata[RW]
config[RW]

This property contains metadata about the payment gateway account's configuration such as the API key, `userId`, and `merchantId` details.

display_name[RW]
is_enabled[RW]
is_legacy[RW]
last_modified[RW]
pay_pal_legacy_settings[RW]

Reserved for DocuSign.

payment_gateway[RW]
payment_gateway_account_id[RW]
payment_gateway_display_name[RW]
supported_currencies[RW]
supported_payment_methods[RW]
supported_payment_methods_with_options[RW]
zero_decimal_currencies[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_esign/models/payment_gateway_account.rb, line 60
def self.attribute_map
  {
    :'allow_custom_metadata' => :'allowCustomMetadata',
    :'config' => :'config',
    :'display_name' => :'displayName',
    :'is_enabled' => :'isEnabled',
    :'is_legacy' => :'isLegacy',
    :'last_modified' => :'lastModified',
    :'payment_gateway' => :'paymentGateway',
    :'payment_gateway_account_id' => :'paymentGatewayAccountId',
    :'payment_gateway_display_name' => :'paymentGatewayDisplayName',
    :'pay_pal_legacy_settings' => :'payPalLegacySettings',
    :'supported_currencies' => :'supportedCurrencies',
    :'supported_payment_methods' => :'supportedPaymentMethods',
    :'supported_payment_methods_with_options' => :'supportedPaymentMethodsWithOptions',
    :'zero_decimal_currencies' => :'zeroDecimalCurrencies'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/docusign_esign/models/payment_gateway_account.rb, line 101
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?(:'allowCustomMetadata')
    self.allow_custom_metadata = attributes[:'allowCustomMetadata']
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'zeroDecimalCurrencies')
    if (value = attributes[:'zeroDecimalCurrencies']).is_a?(Array)
      self.zero_decimal_currencies = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/payment_gateway_account.rb, line 80
def self.swagger_types
  {
    :'allow_custom_metadata' => :'BOOLEAN',
    :'config' => :'PaymentGatewayAccountSetting',
    :'display_name' => :'String',
    :'is_enabled' => :'String',
    :'is_legacy' => :'String',
    :'last_modified' => :'String',
    :'payment_gateway' => :'String',
    :'payment_gateway_account_id' => :'String',
    :'payment_gateway_display_name' => :'String',
    :'pay_pal_legacy_settings' => :'PayPalLegacySettings',
    :'supported_currencies' => :'Array<String>',
    :'supported_payment_methods' => :'Array<String>',
    :'supported_payment_methods_with_options' => :'Array<PaymentMethodWithOptions>',
    :'zero_decimal_currencies' => :'Array<String>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/docusign_esign/models/payment_gateway_account.rb, line 187
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_custom_metadata == o.allow_custom_metadata &&
      config == o.config &&
      display_name == o.display_name &&
      is_enabled == o.is_enabled &&
      is_legacy == o.is_legacy &&
      last_modified == o.last_modified &&
      payment_gateway == o.payment_gateway &&
      payment_gateway_account_id == o.payment_gateway_account_id &&
      payment_gateway_display_name == o.payment_gateway_display_name &&
      pay_pal_legacy_settings == o.pay_pal_legacy_settings &&
      supported_currencies == o.supported_currencies &&
      supported_payment_methods == o.supported_payment_methods &&
      supported_payment_methods_with_options == o.supported_payment_methods_with_options &&
      zero_decimal_currencies == o.zero_decimal_currencies
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/docusign_esign/models/payment_gateway_account.rb, line 242
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 = DocuSign_eSign.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/docusign_esign/models/payment_gateway_account.rb, line 308
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/docusign_esign/models/payment_gateway_account.rb, line 221
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/docusign_esign/models/payment_gateway_account.rb, line 208
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/docusign_esign/models/payment_gateway_account.rb, line 214
def hash
  [allow_custom_metadata, config, display_name, is_enabled, is_legacy, last_modified, payment_gateway, payment_gateway_account_id, payment_gateway_display_name, pay_pal_legacy_settings, supported_currencies, supported_payment_methods, supported_payment_methods_with_options, zero_decimal_currencies].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/docusign_esign/models/payment_gateway_account.rb, line 174
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/docusign_esign/models/payment_gateway_account.rb, line 288
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/docusign_esign/models/payment_gateway_account.rb, line 294
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/docusign_esign/models/payment_gateway_account.rb, line 282
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/docusign_esign/models/payment_gateway_account.rb, line 181
def valid?
  true
end