class DocuSign_eSign::BillingPlanInformation

Attributes

app_store_receipt[RW]
billing_address[RW]
credit_card_information[RW]
direct_debit_processor_information[RW]
downgrade_reason[RW]
enable_pre_auth[RW]
enable_support[RW]
included_seats[RW]

The number of seats (users) included.

incremental_seats[RW]

Reserved: TBD

payment_method[RW]
payment_processor_information[RW]
plan_information[RW]
process_payment[RW]
referral_information[RW]
renewal_status[RW]
sale_discount_amount[RW]
sale_discount_fixed_amount[RW]
sale_discount_percent[RW]
sale_discount_periods[RW]
sale_discount_seat_price_override[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/billing_plan_information.rb, line 73
def self.attribute_map
  {
    :'app_store_receipt' => :'appStoreReceipt',
    :'billing_address' => :'billingAddress',
    :'credit_card_information' => :'creditCardInformation',
    :'direct_debit_processor_information' => :'directDebitProcessorInformation',
    :'downgrade_reason' => :'downgradeReason',
    :'enable_pre_auth' => :'enablePreAuth',
    :'enable_support' => :'enableSupport',
    :'included_seats' => :'includedSeats',
    :'incremental_seats' => :'incrementalSeats',
    :'payment_method' => :'paymentMethod',
    :'payment_processor_information' => :'paymentProcessorInformation',
    :'plan_information' => :'planInformation',
    :'process_payment' => :'processPayment',
    :'referral_information' => :'referralInformation',
    :'renewal_status' => :'renewalStatus',
    :'sale_discount_amount' => :'saleDiscountAmount',
    :'sale_discount_fixed_amount' => :'saleDiscountFixedAmount',
    :'sale_discount_percent' => :'saleDiscountPercent',
    :'sale_discount_periods' => :'saleDiscountPeriods',
    :'sale_discount_seat_price_override' => :'saleDiscountSeatPriceOverride',
    :'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/billing_plan_information.rb, line 128
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?(:'appStoreReceipt')
    self.app_store_receipt = attributes[:'appStoreReceipt']
  end

  if attributes.has_key?(:'billingAddress')
    self.billing_address = attributes[:'billingAddress']
  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?(:'downgradeReason')
    self.downgrade_reason = attributes[:'downgradeReason']
  end

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

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

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

  if attributes.has_key?(:'incrementalSeats')
    self.incremental_seats = attributes[:'incrementalSeats']
  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?(:'planInformation')
    self.plan_information = attributes[:'planInformation']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'saleDiscountSeatPriceOverride')
    self.sale_discount_seat_price_override = attributes[:'saleDiscountSeatPriceOverride']
  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/billing_plan_information.rb, line 100
def self.swagger_types
  {
    :'app_store_receipt' => :'AppStoreReceipt',
    :'billing_address' => :'AccountAddress',
    :'credit_card_information' => :'CreditCardInformation',
    :'direct_debit_processor_information' => :'DirectDebitProcessorInformation',
    :'downgrade_reason' => :'String',
    :'enable_pre_auth' => :'String',
    :'enable_support' => :'String',
    :'included_seats' => :'String',
    :'incremental_seats' => :'String',
    :'payment_method' => :'String',
    :'payment_processor_information' => :'PaymentProcessorInformation',
    :'plan_information' => :'PlanInformation',
    :'process_payment' => :'String',
    :'referral_information' => :'ReferralInformation',
    :'renewal_status' => :'String',
    :'sale_discount_amount' => :'String',
    :'sale_discount_fixed_amount' => :'String',
    :'sale_discount_percent' => :'String',
    :'sale_discount_periods' => :'String',
    :'sale_discount_seat_price_override' => :'String',
    :'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/billing_plan_information.rb, line 234
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app_store_receipt == o.app_store_receipt &&
      billing_address == o.billing_address &&
      credit_card_information == o.credit_card_information &&
      direct_debit_processor_information == o.direct_debit_processor_information &&
      downgrade_reason == o.downgrade_reason &&
      enable_pre_auth == o.enable_pre_auth &&
      enable_support == o.enable_support &&
      included_seats == o.included_seats &&
      incremental_seats == o.incremental_seats &&
      payment_method == o.payment_method &&
      payment_processor_information == o.payment_processor_information &&
      plan_information == o.plan_information &&
      process_payment == o.process_payment &&
      referral_information == o.referral_information &&
      renewal_status == o.renewal_status &&
      sale_discount_amount == o.sale_discount_amount &&
      sale_discount_fixed_amount == o.sale_discount_fixed_amount &&
      sale_discount_percent == o.sale_discount_percent &&
      sale_discount_periods == o.sale_discount_periods &&
      sale_discount_seat_price_override == o.sale_discount_seat_price_override &&
      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/billing_plan_information.rb, line 296
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/billing_plan_information.rb, line 362
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/billing_plan_information.rb, line 275
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/billing_plan_information.rb, line 262
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/billing_plan_information.rb, line 268
def hash
  [app_store_receipt, billing_address, credit_card_information, direct_debit_processor_information, downgrade_reason, enable_pre_auth, enable_support, included_seats, incremental_seats, payment_method, payment_processor_information, plan_information, process_payment, referral_information, renewal_status, sale_discount_amount, sale_discount_fixed_amount, sale_discount_percent, sale_discount_periods, sale_discount_seat_price_override, 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/billing_plan_information.rb, line 221
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/billing_plan_information.rb, line 342
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/billing_plan_information.rb, line 348
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/billing_plan_information.rb, line 336
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/billing_plan_information.rb, line 228
def valid?
  true
end