Class: DocuSign_eSign::BillingPlanInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/billing_plan_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BillingPlanInformation

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
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
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 114

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?(:'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?(:'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
end

Instance Attribute Details

#app_store_receiptObject

Returns the value of attribute app_store_receipt


17
18
19
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 17

def app_store_receipt
  @app_store_receipt
end

#billing_addressObject

Returns the value of attribute billing_address


19
20
21
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 19

def billing_address
  @billing_address
end

#credit_card_informationObject

Returns the value of attribute credit_card_information


21
22
23
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 21

def credit_card_information
  @credit_card_information
end

#direct_debit_processor_informationObject

Returns the value of attribute direct_debit_processor_information


23
24
25
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 23

def direct_debit_processor_information
  @direct_debit_processor_information
end

#downgrade_reasonObject

Returns the value of attribute downgrade_reason


26
27
28
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 26

def downgrade_reason
  @downgrade_reason
end

#enable_supportObject

Returns the value of attribute enable_support


29
30
31
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 29

def enable_support
  @enable_support
end

#included_seatsObject

The number of seats (users) included.


32
33
34
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 32

def included_seats
  @included_seats
end

#incremental_seatsObject

Reserved: TBD


35
36
37
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 35

def incremental_seats
  @incremental_seats
end

#payment_methodObject

Returns the value of attribute payment_method


38
39
40
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 38

def payment_method
  @payment_method
end

#payment_processor_informationObject

Returns the value of attribute payment_processor_information


40
41
42
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 40

def payment_processor_information
  @payment_processor_information
end

#plan_informationObject

Returns the value of attribute plan_information


42
43
44
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 42

def plan_information
  @plan_information
end

#referral_informationObject

Returns the value of attribute referral_information


44
45
46
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 44

def referral_information
  @referral_information
end

#renewal_statusObject

Returns the value of attribute renewal_status


47
48
49
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 47

def renewal_status
  @renewal_status
end

#sale_discount_amountObject

Returns the value of attribute sale_discount_amount


50
51
52
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 50

def sale_discount_amount
  @sale_discount_amount
end

#sale_discount_fixed_amountObject

Returns the value of attribute sale_discount_fixed_amount


53
54
55
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 53

def sale_discount_fixed_amount
  @sale_discount_fixed_amount
end

#sale_discount_percentObject

Returns the value of attribute sale_discount_percent


56
57
58
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 56

def sale_discount_percent
  @sale_discount_percent
end

#sale_discount_periodsObject

Returns the value of attribute sale_discount_periods


59
60
61
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 59

def sale_discount_periods
  @sale_discount_periods
end

#sale_discount_seat_price_overrideObject

Returns the value of attribute sale_discount_seat_price_override


62
63
64
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 62

def sale_discount_seat_price_override
  @sale_discount_seat_price_override
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 65

def self.attribute_map
  {
    :'app_store_receipt' => :'appStoreReceipt',
    :'billing_address' => :'billingAddress',
    :'credit_card_information' => :'creditCardInformation',
    :'direct_debit_processor_information' => :'directDebitProcessorInformation',
    :'downgrade_reason' => :'downgradeReason',
    :'enable_support' => :'enableSupport',
    :'included_seats' => :'includedSeats',
    :'incremental_seats' => :'incrementalSeats',
    :'payment_method' => :'paymentMethod',
    :'payment_processor_information' => :'paymentProcessorInformation',
    :'plan_information' => :'planInformation',
    :'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'
  }
end

.swagger_typesObject

Attribute type mapping.


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 89

def self.swagger_types
  {
    :'app_store_receipt' => :'AppStoreReceipt',
    :'billing_address' => :'AccountAddress',
    :'credit_card_information' => :'CreditCardInformation',
    :'direct_debit_processor_information' => :'DirectDebitProcessorInformation',
    :'downgrade_reason' => :'String',
    :'enable_support' => :'String',
    :'included_seats' => :'String',
    :'incremental_seats' => :'String',
    :'payment_method' => :'String',
    :'payment_processor_information' => :'PaymentProcessorInformation',
    :'plan_information' => :'PlanInformation',
    :'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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 208

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_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 &&
      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
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 267

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

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 333

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

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 246

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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

233
234
235
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 233

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


239
240
241
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 239

def hash
  [app_store_receipt, billing_address, credit_card_information, direct_debit_processor_information, downgrade_reason, enable_support, included_seats, incremental_seats, payment_method, payment_processor_information, plan_information, referral_information, renewal_status, sale_discount_amount, sale_discount_fixed_amount, sale_discount_percent, sale_discount_periods, sale_discount_seat_price_override].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


195
196
197
198
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 195

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


313
314
315
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 313

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


319
320
321
322
323
324
325
326
327
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 319

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


307
308
309
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 307

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


202
203
204
# File 'lib/docusign_esign/models/billing_plan_information.rb', line 202

def valid?
  true
end