class DocuSign_eSign::PlanInformation
An object used to identify the features and attributes of the account being created.
Attributes
Reserved:
Specifies the ISO currency code for the account.
Reserved for DocuSign use only.
A complex type that sets the feature sets for the account.
The DocuSign Plan ID for the account.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docusign_esign/models/plan_information.rb, line 36 def self.attribute_map { :'add_ons' => :'addOns', :'currency_code' => :'currencyCode', :'free_trial_days_override' => :'freeTrialDaysOverride', :'plan_feature_sets' => :'planFeatureSets', :'plan_id' => :'planId', :'recipient_domains' => :'recipientDomains' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docusign_esign/models/plan_information.rb, line 61 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?(:'addOns') if (value = attributes[:'addOns']).is_a?(Array) self.add_ons = value end end if attributes.has_key?(:'currencyCode') self.currency_code = attributes[:'currencyCode'] end if attributes.has_key?(:'freeTrialDaysOverride') self.free_trial_days_override = attributes[:'freeTrialDaysOverride'] end if attributes.has_key?(:'planFeatureSets') if (value = attributes[:'planFeatureSets']).is_a?(Array) self.plan_feature_sets = value end end if attributes.has_key?(:'planId') self.plan_id = attributes[:'planId'] end if attributes.has_key?(:'recipientDomains') if (value = attributes[:'recipientDomains']).is_a?(Array) self.recipient_domains = value end end end
Attribute type mapping.
# File lib/docusign_esign/models/plan_information.rb, line 48 def self.swagger_types { :'add_ons' => :'Array<AddOn>', :'currency_code' => :'String', :'free_trial_days_override' => :'String', :'plan_feature_sets' => :'Array<FeatureSet>', :'plan_id' => :'String', :'recipient_domains' => :'Array<RecipientDomain>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/docusign_esign/models/plan_information.rb, line 113 def ==(o) return true if self.equal?(o) self.class == o.class && add_ons == o.add_ons && currency_code == o.currency_code && free_trial_days_override == o.free_trial_days_override && plan_feature_sets == o.plan_feature_sets && plan_id == o.plan_id && recipient_domains == o.recipient_domains end
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/plan_information.rb, line 160 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
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/plan_information.rb, line 226 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
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/plan_information.rb, line 139 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
@see the `==` method @param [Object] Object
to be compared
# File lib/docusign_esign/models/plan_information.rb, line 126 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docusign_esign/models/plan_information.rb, line 132 def hash [add_ons, currency_code, free_trial_days_override, plan_feature_sets, plan_id, recipient_domains].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/docusign_esign/models/plan_information.rb, line 100 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/docusign_esign/models/plan_information.rb, line 212 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/docusign_esign/models/plan_information.rb, line 200 def to_s to_hash.to_s end
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/plan_information.rb, line 107 def valid? true end