Class: DocuSign_eSign::AccountBillingPlanResponse

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

Overview

Defines an account billing plan response object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountBillingPlanResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 96

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?(:'billingAddress')
    self.billing_address = attributes[:'billingAddress']
  end

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

  if attributes.has_key?(:'billingPlan')
    self.billing_plan = attributes[:'billingPlan']
  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?(:'downgradePlanInformation')
    self.downgrade_plan_information = attributes[:'downgradePlanInformation']
  end

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

  if attributes.has_key?(:'entityInformation')
    self.entity_information = attributes[:'entityInformation']
  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?(:'referralInformation')
    self.referral_information = attributes[:'referralInformation']
  end

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

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

Instance Attribute Details

#billing_address ⇒ Object

The billing address for the account.



18
19
20
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 18

def billing_address
  @billing_address
end

#billing_address_is_credit_card_address ⇒ Object

When set to true, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different.



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

def billing_address_is_credit_card_address
  @billing_address_is_credit_card_address
end

#billing_plan ⇒ Object

An object that contains details about the billing plan.



24
25
26
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 24

def billing_plan
  @billing_plan
end

#credit_card_information ⇒ Object

A complex type that has information about the credit card used to pay for this account.



27
28
29
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 27

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.



30
31
32
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 30

def direct_debit_processor_information
  @direct_debit_processor_information
end

#downgrade_plan_information ⇒ Object

Returns the value of attribute downgrade_plan_information.



33
34
35
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 33

def downgrade_plan_information
  @downgrade_plan_information
end

#downgrade_request_information ⇒ Object

Returns the value of attribute downgrade_request_information.



36
37
38
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 36

def downgrade_request_information
  @downgrade_request_information
end

#entity_information ⇒ Object

Returns the value of attribute entity_information.



39
40
41
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 39

def entity_information
  @entity_information
end

#payment_method ⇒ Object

Returns the value of attribute payment_method.



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

def payment_method
  @payment_method
end

#payment_processor_information ⇒ Object

Information about the entity that processes payments for the billing plan.



45
46
47
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 45

def payment_processor_information
  @payment_processor_information
end

#referral_information ⇒ Object

A complex type that contains properties for entering referral and discount information.



48
49
50
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 48

def referral_information
  @referral_information
end

#successor_plans ⇒ Object

Returns the value of attribute successor_plans.



51
52
53
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 51

def successor_plans
  @successor_plans
end

#tax_exempt_id ⇒ Object

Returns the value of attribute tax_exempt_id.



54
55
56
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 54

def tax_exempt_id
  @tax_exempt_id
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 57

def self.attribute_map
  {
    :'billing_address' => :'billingAddress',
    :'billing_address_is_credit_card_address' => :'billingAddressIsCreditCardAddress',
    :'billing_plan' => :'billingPlan',
    :'credit_card_information' => :'creditCardInformation',
    :'direct_debit_processor_information' => :'directDebitProcessorInformation',
    :'downgrade_plan_information' => :'downgradePlanInformation',
    :'downgrade_request_information' => :'downgradeRequestInformation',
    :'entity_information' => :'entityInformation',
    :'payment_method' => :'paymentMethod',
    :'payment_processor_information' => :'paymentProcessorInformation',
    :'referral_information' => :'referralInformation',
    :'successor_plans' => :'successorPlans',
    :'tax_exempt_id' => :'taxExemptId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 76

def self.swagger_types
  {
    :'billing_address' => :'AccountAddress',
    :'billing_address_is_credit_card_address' => :'String',
    :'billing_plan' => :'AccountBillingPlan',
    :'credit_card_information' => :'CreditCardInformation',
    :'direct_debit_processor_information' => :'DirectDebitProcessorInformation',
    :'downgrade_plan_information' => :'DowngradePlanUpdateResponse',
    :'downgrade_request_information' => :'DowngradeRequestInformation',
    :'entity_information' => :'BillingEntityInformationResponse',
    :'payment_method' => :'String',
    :'payment_processor_information' => :'PaymentProcessorInformation',
    :'referral_information' => :'ReferralInformation',
    :'successor_plans' => :'Array<BillingPlan>',
    :'tax_exempt_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      billing_address == o.billing_address &&
      billing_address_is_credit_card_address == o.billing_address_is_credit_card_address &&
      billing_plan == o.billing_plan &&
      credit_card_information == o.credit_card_information &&
      direct_debit_processor_information == o.direct_debit_processor_information &&
      downgrade_plan_information == o.downgrade_plan_information &&
      downgrade_request_information == o.downgrade_request_information &&
      entity_information == o.entity_information &&
      payment_method == o.payment_method &&
      payment_processor_information == o.payment_processor_information &&
      referral_information == o.referral_information &&
      successor_plans == o.successor_plans &&
      tax_exempt_id == o.tax_exempt_id
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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 226

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 292

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 205

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


192
193
194
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



198
199
200
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 198

def hash
  [billing_address, billing_address_is_credit_card_address, billing_plan, credit_card_information, direct_debit_processor_information, downgrade_plan_information, downgrade_request_information, entity_information, payment_method, payment_processor_information, referral_information, successor_plans, tax_exempt_id].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



159
160
161
162
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 159

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



272
273
274
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 272

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



278
279
280
281
282
283
284
285
286
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 278

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

Returns:

  • (String) —

    String presentation of the object



266
267
268
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 266

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



166
167
168
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 166

def valid?
  true
end