class DocuSign_eSign::AccountInformation

Contains account Information.

Attributes

account_id_guid[RW]

The GUID associated with the account ID.

account_name[RW]

The name of the current account.

account_settings[RW]

allow_transaction_rooms[RW]

When set to true, the transaction rooms feature exposed through the Workspaces API is enabled.

billing_period_days_remaining[RW]

Reserved: TBD

billing_period_end_date[RW]

Reserved: TBD

billing_period_envelopes_allowed[RW]

Reserved: TBD

billing_period_envelopes_sent[RW]

Reserved: TBD

billing_period_start_date[RW]

Reserved: TBD

billing_profile[RW]

Reserved: TBD

brands[RW]

can_upgrade[RW]

When set to true, specifies that you can upgrade the account through the API.

connect_permission[RW]

created_date[RW]

currency_code[RW]

Specifies the ISO currency code for the account.

current_plan_id[RW]

Identifies the plan that was used create this account.

display_appliance_start_url[RW]

display_appliance_url[RW]

distributor_code[RW]

The code that identifies the billing plan groups and plans for the new account.

docu_sign_landing_url[RW]

dss_values[RW]

envelope_sending_blocked[RW]

envelope_unit_price[RW]

external_account_id[RW]

forgotten_password_questions_count[RW]

A complex element that contains up to four Question/Answer pairs for forgotten password information for a user.

is_downgrade[RW]

payment_method[RW]

plan_classification[RW]

Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.

plan_end_date[RW]

The date that the current plan will end.

plan_name[RW]

The name of the Billing Plan.

plan_start_date[RW]

The date that the Account started using the current plan.

recipient_domains[RW]

seats_allowed[RW]

seats_in_use[RW]

status21_cfr_part11[RW]

suspension_date[RW]

suspension_status[RW]

use_display_appliance[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_information.rb, line 130
def self.attribute_map
  {
    :'account_id_guid' => :'accountIdGuid',
    :'account_name' => :'accountName',
    :'account_settings' => :'accountSettings',
    :'allow_transaction_rooms' => :'allowTransactionRooms',
    :'billing_period_days_remaining' => :'billingPeriodDaysRemaining',
    :'billing_period_end_date' => :'billingPeriodEndDate',
    :'billing_period_envelopes_allowed' => :'billingPeriodEnvelopesAllowed',
    :'billing_period_envelopes_sent' => :'billingPeriodEnvelopesSent',
    :'billing_period_start_date' => :'billingPeriodStartDate',
    :'billing_profile' => :'billingProfile',
    :'brands' => :'brands',
    :'can_upgrade' => :'canUpgrade',
    :'connect_permission' => :'connectPermission',
    :'created_date' => :'createdDate',
    :'currency_code' => :'currencyCode',
    :'current_plan_id' => :'currentPlanId',
    :'display_appliance_start_url' => :'displayApplianceStartUrl',
    :'display_appliance_url' => :'displayApplianceUrl',
    :'distributor_code' => :'distributorCode',
    :'docu_sign_landing_url' => :'docuSignLandingUrl',
    :'dss_values' => :'dssValues',
    :'envelope_sending_blocked' => :'envelopeSendingBlocked',
    :'envelope_unit_price' => :'envelopeUnitPrice',
    :'external_account_id' => :'externalAccountId',
    :'forgotten_password_questions_count' => :'forgottenPasswordQuestionsCount',
    :'is_downgrade' => :'isDowngrade',
    :'payment_method' => :'paymentMethod',
    :'plan_classification' => :'planClassification',
    :'plan_end_date' => :'planEndDate',
    :'plan_name' => :'planName',
    :'plan_start_date' => :'planStartDate',
    :'recipient_domains' => :'recipientDomains',
    :'seats_allowed' => :'seatsAllowed',
    :'seats_in_use' => :'seatsInUse',
    :'status21_cfr_part11' => :'status21CFRPart11',
    :'suspension_date' => :'suspensionDate',
    :'suspension_status' => :'suspensionStatus',
    :'use_display_appliance' => :'useDisplayAppliance'
  }
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_information.rb, line 219
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?(:'accountIdGuid')
    self.account_id_guid = attributes[:'accountIdGuid']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'dssValues')
    if (value = attributes[:'dssValues']).is_a?(Hash)
      self.dss_values = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/account_information.rb, line 174
def self.swagger_types
  {
    :'account_id_guid' => :'String',
    :'account_name' => :'String',
    :'account_settings' => :'AccountSettingsInformation',
    :'allow_transaction_rooms' => :'String',
    :'billing_period_days_remaining' => :'String',
    :'billing_period_end_date' => :'String',
    :'billing_period_envelopes_allowed' => :'String',
    :'billing_period_envelopes_sent' => :'String',
    :'billing_period_start_date' => :'String',
    :'billing_profile' => :'String',
    :'brands' => :'BrandsResponse',
    :'can_upgrade' => :'String',
    :'connect_permission' => :'String',
    :'created_date' => :'String',
    :'currency_code' => :'String',
    :'current_plan_id' => :'String',
    :'display_appliance_start_url' => :'String',
    :'display_appliance_url' => :'String',
    :'distributor_code' => :'String',
    :'docu_sign_landing_url' => :'String',
    :'dss_values' => :'Hash<String, String>',
    :'envelope_sending_blocked' => :'String',
    :'envelope_unit_price' => :'String',
    :'external_account_id' => :'String',
    :'forgotten_password_questions_count' => :'String',
    :'is_downgrade' => :'String',
    :'payment_method' => :'String',
    :'plan_classification' => :'String',
    :'plan_end_date' => :'String',
    :'plan_name' => :'String',
    :'plan_start_date' => :'String',
    :'recipient_domains' => :'Array<RecipientDomain>',
    :'seats_allowed' => :'String',
    :'seats_in_use' => :'String',
    :'status21_cfr_part11' => :'String',
    :'suspension_date' => :'String',
    :'suspension_status' => :'String',
    :'use_display_appliance' => :'BOOLEAN'
  }
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_information.rb, line 397
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_id_guid == o.account_id_guid &&
      account_name == o.account_name &&
      account_settings == o.account_settings &&
      allow_transaction_rooms == o.allow_transaction_rooms &&
      billing_period_days_remaining == o.billing_period_days_remaining &&
      billing_period_end_date == o.billing_period_end_date &&
      billing_period_envelopes_allowed == o.billing_period_envelopes_allowed &&
      billing_period_envelopes_sent == o.billing_period_envelopes_sent &&
      billing_period_start_date == o.billing_period_start_date &&
      billing_profile == o.billing_profile &&
      brands == o.brands &&
      can_upgrade == o.can_upgrade &&
      connect_permission == o.connect_permission &&
      created_date == o.created_date &&
      currency_code == o.currency_code &&
      current_plan_id == o.current_plan_id &&
      display_appliance_start_url == o.display_appliance_start_url &&
      display_appliance_url == o.display_appliance_url &&
      distributor_code == o.distributor_code &&
      docu_sign_landing_url == o.docu_sign_landing_url &&
      dss_values == o.dss_values &&
      envelope_sending_blocked == o.envelope_sending_blocked &&
      envelope_unit_price == o.envelope_unit_price &&
      external_account_id == o.external_account_id &&
      forgotten_password_questions_count == o.forgotten_password_questions_count &&
      is_downgrade == o.is_downgrade &&
      payment_method == o.payment_method &&
      plan_classification == o.plan_classification &&
      plan_end_date == o.plan_end_date &&
      plan_name == o.plan_name &&
      plan_start_date == o.plan_start_date &&
      recipient_domains == o.recipient_domains &&
      seats_allowed == o.seats_allowed &&
      seats_in_use == o.seats_in_use &&
      status21_cfr_part11 == o.status21_cfr_part11 &&
      suspension_date == o.suspension_date &&
      suspension_status == o.suspension_status &&
      use_display_appliance == o.use_display_appliance
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_information.rb, line 476
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_information.rb, line 542
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_information.rb, line 455
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_information.rb, line 442
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_information.rb, line 448
def hash
  [account_id_guid, account_name, account_settings, allow_transaction_rooms, billing_period_days_remaining, billing_period_end_date, billing_period_envelopes_allowed, billing_period_envelopes_sent, billing_period_start_date, billing_profile, brands, can_upgrade, connect_permission, created_date, currency_code, current_plan_id, display_appliance_start_url, display_appliance_url, distributor_code, docu_sign_landing_url, dss_values, envelope_sending_blocked, envelope_unit_price, external_account_id, forgotten_password_questions_count, is_downgrade, payment_method, plan_classification, plan_end_date, plan_name, plan_start_date, recipient_domains, seats_allowed, seats_in_use, status21_cfr_part11, suspension_date, suspension_status, use_display_appliance].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_information.rb, line 384
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_information.rb, line 522
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_information.rb, line 528
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_information.rb, line 516
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_information.rb, line 391
def valid?
  true
end