Class: DocuSign_eSign::BillingPlanInformation
- Inherits:
-
Object
- Object
- DocuSign_eSign::BillingPlanInformation
- Defined in:
- lib/docusign_esign/models/billing_plan_information.rb
Overview
This object contains details about a billing plan.
Instance Attribute Summary collapse
-
#app_store_receipt ⇒ Object
Returns the value of attribute app_store_receipt.
-
#billing_address ⇒ Object
The billing address for the account.
-
#credit_card_information ⇒ Object
A complex type that has information about the credit card used to pay for this account.
-
#direct_debit_processor_information ⇒ Object
Information about the bank that processes direct debits for the payment plan.
-
#downgrade_reason ⇒ Object
Returns the value of attribute downgrade_reason.
-
#enable_pre_auth ⇒ Object
Returns the value of attribute enable_pre_auth.
-
#enable_support ⇒ Object
Returns the value of attribute enable_support.
-
#included_seats ⇒ Object
The number of seats (users) included.
-
#incremental_seats ⇒ Object
Reserved: TBD.
-
#payment_method ⇒ Object
Returns the value of attribute payment_method.
-
#payment_processor ⇒ Object
Returns the value of attribute payment_processor.
-
#payment_processor_information ⇒ Object
Information about the entity that processes payments for the billing plan.
-
#plan_information ⇒ Object
An object used to identify the features and attributes of the account being created.
-
#process_payment ⇒ Object
Returns the value of attribute process_payment.
-
#referral_information ⇒ Object
A complex type that contains properties for entering referral and discount information.
-
#renewal_status ⇒ Object
Returns the value of attribute renewal_status.
-
#sale_discount_amount ⇒ Object
Returns the value of attribute sale_discount_amount.
-
#sale_discount_fixed_amount ⇒ Object
Returns the value of attribute sale_discount_fixed_amount.
-
#sale_discount_percent ⇒ Object
Returns the value of attribute sale_discount_percent.
-
#sale_discount_periods ⇒ Object
Returns the value of attribute sale_discount_periods.
-
#sale_discount_seat_price_override ⇒ Object
Returns the value of attribute sale_discount_seat_price_override.
-
#tax_exempt_id ⇒ Object
Returns the value of attribute tax_exempt_id.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ BillingPlanInformation
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ BillingPlanInformation
Initializes the object
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 141 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?(:'paymentProcessor') self.payment_processor = attributes[:'paymentProcessor'] 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 |
Instance Attribute Details
#app_store_receipt ⇒ Object
Returns the value of attribute app_store_receipt.
18 19 20 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 18 def app_store_receipt @app_store_receipt end |
#billing_address ⇒ Object
The billing address for the account.
21 22 23 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 21 def billing_address @billing_address end |
#credit_card_information ⇒ Object
A complex type that has information about the credit card used to pay for this account.
24 25 26 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 24 def credit_card_information @credit_card_information end |
#direct_debit_processor_information ⇒ Object
Information about the bank that processes direct debits for the payment plan.
27 28 29 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 27 def direct_debit_processor_information @direct_debit_processor_information end |
#downgrade_reason ⇒ Object
Returns the value of attribute downgrade_reason.
30 31 32 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 30 def downgrade_reason @downgrade_reason end |
#enable_pre_auth ⇒ Object
Returns the value of attribute enable_pre_auth.
33 34 35 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 33 def enable_pre_auth @enable_pre_auth end |
#enable_support ⇒ Object
Returns the value of attribute enable_support.
36 37 38 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 36 def enable_support @enable_support end |
#included_seats ⇒ Object
The number of seats (users) included.
39 40 41 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 39 def included_seats @included_seats end |
#incremental_seats ⇒ Object
Reserved: TBD
42 43 44 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 42 def incremental_seats @incremental_seats end |
#payment_method ⇒ Object
Returns the value of attribute payment_method.
45 46 47 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 45 def payment_method @payment_method end |
#payment_processor ⇒ Object
Returns the value of attribute payment_processor.
48 49 50 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 48 def payment_processor @payment_processor end |
#payment_processor_information ⇒ Object
Information about the entity that processes payments for the billing plan.
51 52 53 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 51 def payment_processor_information @payment_processor_information end |
#plan_information ⇒ Object
An object used to identify the features and attributes of the account being created.
54 55 56 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 54 def plan_information @plan_information end |
#process_payment ⇒ Object
Returns the value of attribute process_payment.
57 58 59 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 57 def process_payment @process_payment end |
#referral_information ⇒ Object
A complex type that contains properties for entering referral and discount information.
60 61 62 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 60 def referral_information @referral_information end |
#renewal_status ⇒ Object
Returns the value of attribute renewal_status.
63 64 65 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 63 def renewal_status @renewal_status end |
#sale_discount_amount ⇒ Object
Returns the value of attribute sale_discount_amount.
66 67 68 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 66 def sale_discount_amount @sale_discount_amount end |
#sale_discount_fixed_amount ⇒ Object
Returns the value of attribute sale_discount_fixed_amount.
69 70 71 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 69 def sale_discount_fixed_amount @sale_discount_fixed_amount end |
#sale_discount_percent ⇒ Object
Returns the value of attribute sale_discount_percent.
72 73 74 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 72 def sale_discount_percent @sale_discount_percent end |
#sale_discount_periods ⇒ Object
Returns the value of attribute sale_discount_periods.
75 76 77 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 75 def sale_discount_periods @sale_discount_periods end |
#sale_discount_seat_price_override ⇒ Object
Returns the value of attribute sale_discount_seat_price_override.
78 79 80 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 78 def sale_discount_seat_price_override @sale_discount_seat_price_override end |
#tax_exempt_id ⇒ Object
Returns the value of attribute tax_exempt_id.
81 82 83 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 81 def tax_exempt_id @tax_exempt_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 84 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' => :'paymentProcessor', :'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 |
.swagger_types ⇒ Object
Attribute type mapping.
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 112 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' => :'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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 251 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 == o.payment_processor && 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) ⇒ Object
Deserializes the data based on type
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 314 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 380 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) ⇒ Object
Builds the object from hash
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 293 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) ⇒ Boolean
280 281 282 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 280 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
286 287 288 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 286 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, 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 ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
238 239 240 241 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 238 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
360 361 362 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 360 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
366 367 368 369 370 371 372 373 374 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 366 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 ⇒ String
Returns the string representation of the object
354 355 356 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 354 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
245 246 247 |
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 245 def valid? true end |