Class: DocuSign_eSign::BillingPayment

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

Overview

Contains information on a billing plan.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BillingPayment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/docusign_esign/models/billing_payment.rb', line 47

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

  if attributes.has_key?(:'invoiceId')
    self.invoice_id = attributes[:'invoiceId']
  end

  if attributes.has_key?(:'paymentId')
    self.payment_id = attributes[:'paymentId']
  end

end

Instance Attribute Details

#amount ⇒ Object

Reserved: TBD



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

def amount
  @amount
end

#invoice_id ⇒ Object

Reserved: TBD



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

def invoice_id
  @invoice_id
end

#payment_id ⇒ Object

Returns the value of attribute payment_id.



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

def payment_id
  @payment_id
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
 
# File 'lib/docusign_esign/models/billing_payment.rb', line 28

def self.attribute_map
  {
    :'amount' => :'amount',
    :'invoice_id' => :'invoiceId',
    :'payment_id' => :'paymentId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
 
# File 'lib/docusign_esign/models/billing_payment.rb', line 37

def self.swagger_types
  {
    :'amount' => :'String',
    :'invoice_id' => :'String',
    :'payment_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



82
83
84
85
86
87
88
 
# File 'lib/docusign_esign/models/billing_payment.rb', line 82

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      invoice_id == o.invoice_id &&
      payment_id == o.payment_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



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

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



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/docusign_esign/models/billing_payment.rb', line 192

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/docusign_esign/models/billing_payment.rb', line 105

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 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


92
93
94
 
# File 'lib/docusign_esign/models/billing_payment.rb', line 92

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



98
99
100
 
# File 'lib/docusign_esign/models/billing_payment.rb', line 98

def hash
  [amount, invoice_id, payment_id].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



69
70
71
72
 
# File 'lib/docusign_esign/models/billing_payment.rb', line 69

def list_invalid_properties
  invalid_properties = Array.new
  return 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



172
173
174
 
# File 'lib/docusign_esign/models/billing_payment.rb', line 172

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



178
179
180
181
182
183
184
185
186
 
# File 'lib/docusign_esign/models/billing_payment.rb', line 178

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



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

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



76
77
78
 
# File 'lib/docusign_esign/models/billing_payment.rb', line 76

def valid?
  return true
end