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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 62

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

Instance Attribute Details

#billing_address ⇒ Object

Returns the value of attribute billing_address.



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

Returns the value of attribute billing_plan.



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

def billing_plan
  @billing_plan
end

#credit_card_information ⇒ Object

Returns the value of attribute credit_card_information.



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

def credit_card_information
  @credit_card_information
end

#payment_processor_information ⇒ Object

Returns the value of attribute payment_processor_information.



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

def payment_processor_information
  @payment_processor_information
end

#referral_information ⇒ Object

Returns the value of attribute referral_information.



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

def referral_information
  @referral_information
end

#successor_plans ⇒ Object

Returns the value of attribute successor_plans.



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

def successor_plans
  @successor_plans
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 35

def self.attribute_map
  {
    :'billing_address' => :'billingAddress',
    :'billing_address_is_credit_card_address' => :'billingAddressIsCreditCardAddress',
    :'billing_plan' => :'billingPlan',
    :'credit_card_information' => :'creditCardInformation',
    :'payment_processor_information' => :'paymentProcessorInformation',
    :'referral_information' => :'referralInformation',
    :'successor_plans' => :'successorPlans'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 48

def self.swagger_types
  {
    :'billing_address' => :'AccountAddress',
    :'billing_address_is_credit_card_address' => :'String',
    :'billing_plan' => :'AccountBillingPlan',
    :'credit_card_information' => :'CreditCardInformation',
    :'payment_processor_information' => :'PaymentProcessorInformation',
    :'referral_information' => :'ReferralInformation',
    :'successor_plans' => :'Array<BillingPlan>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 114

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 &&
      payment_processor_information == o.payment_processor_information &&
      referral_information == o.referral_information &&
      successor_plans == o.successor_plans
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 162

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



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 228

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 141

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

See Also:

  • `==` method


128
129
130
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 128

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



134
135
136
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 134

def hash
  [billing_address, billing_address_is_credit_card_address, billing_plan, credit_card_information, payment_processor_information, referral_information, successor_plans].hash
end

#list_invalid_properties ⇒ Object

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



101
102
103
104
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 101

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



208
209
210
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 208

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



214
215
216
217
218
219
220
221
222
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 214

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



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

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



108
109
110
 
# File 'lib/docusign_esign/models/account_billing_plan_response.rb', line 108

def valid?
  true
end