Class: DocuSign_eSign::BillingPlanUpdateResponse

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

Overview

Defines a billing plan update response object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BillingPlanUpdateResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 71

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

  if attributes.has_key?(:'billingPlanPreview')
    self.billing_plan_preview = attributes[:'billingPlanPreview']
  end

  if attributes.has_key?(:'currencyCode')
    self.currency_code = attributes[:'currencyCode']
  end

  if attributes.has_key?(:'includedSeats')
    self.included_seats = attributes[:'includedSeats']
  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?(:'planId')
    self.plan_id = attributes[:'planId']
  end

  if attributes.has_key?(:'planName')
    self.plan_name = attributes[:'planName']
  end
end

Instance Attribute Details

#account_payment_methodObject

Returns the value of attribute account_payment_method


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

def 
  @account_payment_method
end

#billing_plan_previewObject

Returns the value of attribute billing_plan_preview


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

def billing_plan_preview
  @billing_plan_preview
end

#currency_codeObject

Specifies the ISO currency code for the account.


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

def currency_code
  @currency_code
end

#included_seatsObject

The number of seats (users) included.


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

def included_seats
  @included_seats
end

#payment_cycleObject

Returns the value of attribute payment_cycle


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

def payment_cycle
  @payment_cycle
end

#payment_methodObject

Returns the value of attribute payment_method


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

def payment_method
  @payment_method
end

#plan_idObject

Returns the value of attribute plan_id


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

def plan_id
  @plan_id
end

#plan_nameObject

Returns the value of attribute plan_name


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

def plan_name
  @plan_name
end

Class Method Details

.attribute_mapObject

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


42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 42

def self.attribute_map
  {
    :'account_payment_method' => :'accountPaymentMethod',
    :'billing_plan_preview' => :'billingPlanPreview',
    :'currency_code' => :'currencyCode',
    :'included_seats' => :'includedSeats',
    :'payment_cycle' => :'paymentCycle',
    :'payment_method' => :'paymentMethod',
    :'plan_id' => :'planId',
    :'plan_name' => :'planName'
  }
end

.swagger_typesObject

Attribute type mapping.


56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 56

def self.swagger_types
  {
    :'account_payment_method' => :'String',
    :'billing_plan_preview' => :'BillingPlanPreview',
    :'currency_code' => :'String',
    :'included_seats' => :'String',
    :'payment_cycle' => :'String',
    :'payment_method' => :'String',
    :'plan_id' => :'String',
    :'plan_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 125

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      billing_plan_preview == o.billing_plan_preview &&
      currency_code == o.currency_code &&
      included_seats == o.included_seats &&
      payment_cycle == o.payment_cycle &&
      payment_method == o.payment_method &&
      plan_id == o.plan_id &&
      plan_name == o.plan_name
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


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

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


240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 240

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


153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 153

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

140
141
142
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 140

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


146
147
148
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 146

def hash
  [, billing_plan_preview, currency_code, included_seats, payment_cycle, payment_method, plan_id, plan_name].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


112
113
114
115
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 112

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


220
221
222
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 220

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


226
227
228
229
230
231
232
233
234
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 226

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


214
215
216
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 214

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


119
120
121
# File 'lib/docusign_esign/models/billing_plan_update_response.rb', line 119

def valid?
  true
end