class DocuSign_eSign::BillingPlan
Contains information about a billing plan.
Attributes
Reserved: TBD
Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set.
When set to *true*, then customer support is provided as part of the account plan.
The number of seats (users) included.
The payment cycle associated with the plan. The possible values are: Monthly or Annually.
The per seat price for the plan.
Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.
The name of the Billing Plan.
The support incident fee charged for each support incident.
The support plan fee charged for this plan.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docusign_esign/models/billing_plan.rb, line 63 def self.attribute_map { :'app_store_products' => :'appStoreProducts', :'currency_plan_prices' => :'currencyPlanPrices', :'enable_support' => :'enableSupport', :'included_seats' => :'includedSeats', :'other_discount_percent' => :'otherDiscountPercent', :'payment_cycle' => :'paymentCycle', :'payment_method' => :'paymentMethod', :'per_seat_price' => :'perSeatPrice', :'plan_classification' => :'planClassification', :'plan_feature_sets' => :'planFeatureSets', :'plan_id' => :'planId', :'plan_name' => :'planName', :'seat_discounts' => :'seatDiscounts', :'support_incident_fee' => :'supportIncidentFee', :'support_plan_fee' => :'supportPlanFee' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docusign_esign/models/billing_plan.rb, line 106 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?(:'appStoreProducts') if (value = attributes[:'appStoreProducts']).is_a?(Array) self.app_store_products = value end end if attributes.has_key?(:'currencyPlanPrices') if (value = attributes[:'currencyPlanPrices']).is_a?(Array) self.currency_plan_prices = value end 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?(:'otherDiscountPercent') self.other_discount_percent = attributes[:'otherDiscountPercent'] end if attributes.has_key?(:'paymentCycle') self.payment_cycle = attributes[:'paymentCycle'] end if attributes.has_key?(:'paymentMethod') self.payment_method = attributes[:'paymentMethod'] end if attributes.has_key?(:'perSeatPrice') self.per_seat_price = attributes[:'perSeatPrice'] end if attributes.has_key?(:'planClassification') self.plan_classification = attributes[:'planClassification'] 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?(:'planName') self.plan_name = attributes[:'planName'] end if attributes.has_key?(:'seatDiscounts') if (value = attributes[:'seatDiscounts']).is_a?(Array) self.seat_discounts = value end end if attributes.has_key?(:'supportIncidentFee') self.support_incident_fee = attributes[:'supportIncidentFee'] end if attributes.has_key?(:'supportPlanFee') self.support_plan_fee = attributes[:'supportPlanFee'] end end
Attribute type mapping.
# File lib/docusign_esign/models/billing_plan.rb, line 84 def self.swagger_types { :'app_store_products' => :'Array<AppStoreProduct>', :'currency_plan_prices' => :'Array<CurrencyPlanPrice>', :'enable_support' => :'String', :'included_seats' => :'String', :'other_discount_percent' => :'String', :'payment_cycle' => :'String', :'payment_method' => :'String', :'per_seat_price' => :'String', :'plan_classification' => :'String', :'plan_feature_sets' => :'Array<FeatureSet>', :'plan_id' => :'String', :'plan_name' => :'String', :'seat_discounts' => :'Array<SeatDiscount>', :'support_incident_fee' => :'String', :'support_plan_fee' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/docusign_esign/models/billing_plan.rb, line 196 def ==(o) return true if self.equal?(o) self.class == o.class && app_store_products == o.app_store_products && currency_plan_prices == o.currency_plan_prices && enable_support == o.enable_support && included_seats == o.included_seats && other_discount_percent == o.other_discount_percent && payment_cycle == o.payment_cycle && payment_method == o.payment_method && per_seat_price == o.per_seat_price && plan_classification == o.plan_classification && plan_feature_sets == o.plan_feature_sets && plan_id == o.plan_id && plan_name == o.plan_name && seat_discounts == o.seat_discounts && support_incident_fee == o.support_incident_fee && support_plan_fee == o.support_plan_fee 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/billing_plan.rb, line 252 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/billing_plan.rb, line 318 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/billing_plan.rb, line 231 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/billing_plan.rb, line 218 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docusign_esign/models/billing_plan.rb, line 224 def hash [app_store_products, currency_plan_prices, enable_support, included_seats, other_discount_percent, payment_cycle, payment_method, per_seat_price, plan_classification, plan_feature_sets, plan_id, plan_name, seat_discounts, support_incident_fee, support_plan_fee].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/billing_plan.rb, line 183 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/billing_plan.rb, line 304 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/billing_plan.rb, line 292 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/billing_plan.rb, line 190 def valid? true end