class DocuSign_eSign::AccountBillingPlanResponse

Defines an account billing plan response object.

Attributes

billing_address[RW]

billing_address_is_credit_card_address[RW]

When set to true, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different.

billing_plan[RW]

credit_card_information[RW]

direct_debit_processor_information[RW]

downgrade_plan_information[RW]

downgrade_request_information[RW]

entity_information[RW]

payment_method[RW]

payment_processor_information[RW]

referral_information[RW]

successor_plans[RW]

tax_exempt_id[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/account_billing_plan_response.rb, line 48
def self.attribute_map
  {
    :'billing_address' => :'billingAddress',
    :'billing_address_is_credit_card_address' => :'billingAddressIsCreditCardAddress',
    :'billing_plan' => :'billingPlan',
    :'credit_card_information' => :'creditCardInformation',
    :'direct_debit_processor_information' => :'directDebitProcessorInformation',
    :'downgrade_plan_information' => :'downgradePlanInformation',
    :'downgrade_request_information' => :'downgradeRequestInformation',
    :'entity_information' => :'entityInformation',
    :'payment_method' => :'paymentMethod',
    :'payment_processor_information' => :'paymentProcessorInformation',
    :'referral_information' => :'referralInformation',
    :'successor_plans' => :'successorPlans',
    :'tax_exempt_id' => :'taxExemptId'
  }
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/account_billing_plan_response.rb, line 87
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?(:'billingAddress')
    self.billing_address = attributes[:'billingAddress']
  end

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

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

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

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

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

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

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

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

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

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

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

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

swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/account_billing_plan_response.rb, line 67
def self.swagger_types
  {
    :'billing_address' => :'AccountAddress',
    :'billing_address_is_credit_card_address' => :'String',
    :'billing_plan' => :'AccountBillingPlan',
    :'credit_card_information' => :'CreditCardInformation',
    :'direct_debit_processor_information' => :'DirectDebitProcessorInformation',
    :'downgrade_plan_information' => :'DowngradePlanUpdateResponse',
    :'downgrade_request_information' => :'DowngradeRequestInformation',
    :'entity_information' => :'BillingEntityInformationResponse',
    :'payment_method' => :'String',
    :'payment_processor_information' => :'PaymentProcessorInformation',
    :'referral_information' => :'ReferralInformation',
    :'successor_plans' => :'Array<BillingPlan>',
    :'tax_exempt_id' => :'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/account_billing_plan_response.rb, line 163
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      billing_address == o.billing_address &&
      billing_address_is_credit_card_address == o.billing_address_is_credit_card_address &&
      billing_plan == o.billing_plan &&
      credit_card_information == o.credit_card_information &&
      direct_debit_processor_information == o.direct_debit_processor_information &&
      downgrade_plan_information == o.downgrade_plan_information &&
      downgrade_request_information == o.downgrade_request_information &&
      entity_information == o.entity_information &&
      payment_method == o.payment_method &&
      payment_processor_information == o.payment_processor_information &&
      referral_information == o.referral_information &&
      successor_plans == o.successor_plans &&
      tax_exempt_id == o.tax_exempt_id
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/account_billing_plan_response.rb, line 217
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/account_billing_plan_response.rb, line 283
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/account_billing_plan_response.rb, line 196
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/account_billing_plan_response.rb, line 183
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/account_billing_plan_response.rb, line 189
def hash
  [billing_address, billing_address_is_credit_card_address, billing_plan, credit_card_information, direct_debit_processor_information, downgrade_plan_information, downgrade_request_information, entity_information, payment_method, payment_processor_information, referral_information, successor_plans, tax_exempt_id].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/account_billing_plan_response.rb, line 150
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/account_billing_plan_response.rb, line 263
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/account_billing_plan_response.rb, line 269
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/account_billing_plan_response.rb, line 257
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/account_billing_plan_response.rb, line 157
def valid?
  true
end