class DocuSign_eSign::PaymentDetails

Attributes

allowed_payment_methods[RW]

charge_id[RW]

currency_code[RW]

currency_code_metadata[RW]

custom_metadata[RW]

custom_metadata_required[RW]

customer_id[RW]

gateway_account_id[RW]

gateway_account_id_metadata[RW]

gateway_display_name[RW]

gateway_name[RW]

line_items[RW]

payment_option[RW]

payment_source_id[RW]

signer_values[RW]

status[RW]

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

sub_gateway_name[RW]

total[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_details.rb, line 67
def self.attribute_map
  {
    :'allowed_payment_methods' => :'allowedPaymentMethods',
    :'charge_id' => :'chargeId',
    :'currency_code' => :'currencyCode',
    :'currency_code_metadata' => :'currencyCodeMetadata',
    :'customer_id' => :'customerId',
    :'custom_metadata' => :'customMetadata',
    :'custom_metadata_required' => :'customMetadataRequired',
    :'gateway_account_id' => :'gatewayAccountId',
    :'gateway_account_id_metadata' => :'gatewayAccountIdMetadata',
    :'gateway_display_name' => :'gatewayDisplayName',
    :'gateway_name' => :'gatewayName',
    :'line_items' => :'lineItems',
    :'payment_option' => :'paymentOption',
    :'payment_source_id' => :'paymentSourceId',
    :'signer_values' => :'signerValues',
    :'status' => :'status',
    :'sub_gateway_name' => :'subGatewayName',
    :'total' => :'total'
  }
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_details.rb, line 116
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?(:'allowedPaymentMethods')
    if (value = attributes[:'allowedPaymentMethods']).is_a?(Array)
      self.allowed_payment_methods = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/payment_details.rb, line 91
def self.swagger_types
  {
    :'allowed_payment_methods' => :'Array<String>',
    :'charge_id' => :'String',
    :'currency_code' => :'String',
    :'currency_code_metadata' => :'PropertyMetadata',
    :'customer_id' => :'String',
    :'custom_metadata' => :'String',
    :'custom_metadata_required' => :'BOOLEAN',
    :'gateway_account_id' => :'String',
    :'gateway_account_id_metadata' => :'PropertyMetadata',
    :'gateway_display_name' => :'String',
    :'gateway_name' => :'String',
    :'line_items' => :'Array<PaymentLineItem>',
    :'payment_option' => :'String',
    :'payment_source_id' => :'String',
    :'signer_values' => :'PaymentSignerValues',
    :'status' => :'String',
    :'sub_gateway_name' => :'String',
    :'total' => :'Money'
  }
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_details.rb, line 214
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allowed_payment_methods == o.allowed_payment_methods &&
      charge_id == o.charge_id &&
      currency_code == o.currency_code &&
      currency_code_metadata == o.currency_code_metadata &&
      customer_id == o.customer_id &&
      custom_metadata == o.custom_metadata &&
      custom_metadata_required == o.custom_metadata_required &&
      gateway_account_id == o.gateway_account_id &&
      gateway_account_id_metadata == o.gateway_account_id_metadata &&
      gateway_display_name == o.gateway_display_name &&
      gateway_name == o.gateway_name &&
      line_items == o.line_items &&
      payment_option == o.payment_option &&
      payment_source_id == o.payment_source_id &&
      signer_values == o.signer_values &&
      status == o.status &&
      sub_gateway_name == o.sub_gateway_name &&
      total == o.total
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_details.rb, line 273
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_details.rb, line 339
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_details.rb, line 252
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_details.rb, line 239
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_details.rb, line 245
def hash
  [allowed_payment_methods, charge_id, currency_code, currency_code_metadata, customer_id, custom_metadata, custom_metadata_required, gateway_account_id, gateway_account_id_metadata, gateway_display_name, gateway_name, line_items, payment_option, payment_source_id, signer_values, status, sub_gateway_name, total].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_details.rb, line 201
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_details.rb, line 319
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_details.rb, line 325
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_details.rb, line 313
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_details.rb, line 208
def valid?
  true
end