Class: DocuSign_eSign::BillingCharge

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

Overview

Contains information about a billing charge.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BillingCharge

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
156
157
158
# File 'lib/docusign_esign/models/billing_charge.rb', line 97

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

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

  if attributes.has_key?(:'chargeName')
    self.charge_name = attributes[:'chargeName']
  end

  if attributes.has_key?(:'chargeType')
    self.charge_type = attributes[:'chargeType']
  end

  if attributes.has_key?(:'chargeUnitOfMeasure')
    self.charge_unit_of_measure = attributes[:'chargeUnitOfMeasure']
  end

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

  if attributes.has_key?(:'firstEffectiveDate')
    self.first_effective_date = attributes[:'firstEffectiveDate']
  end

  if attributes.has_key?(:'includedQuantity')
    self.included_quantity = attributes[:'includedQuantity']
  end

  if attributes.has_key?(:'incrementalQuantity')
    self.incremental_quantity = attributes[:'incrementalQuantity']
  end

  if attributes.has_key?(:'lastEffectiveDate')
    self.last_effective_date = attributes[:'lastEffectiveDate']
  end

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

  if attributes.has_key?(:'unitPrice')
    self.unit_price = attributes[:'unitPrice']
  end

  if attributes.has_key?(:'usedQuantity')
    self.used_quantity = attributes[:'usedQuantity']
  end
end

Instance Attribute Details

#allowed_quantityObject

Reserved: TBD


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

def allowed_quantity
  @allowed_quantity
end

#blockedObject

Reserved: TBD


22
23
24
# File 'lib/docusign_esign/models/billing_charge.rb', line 22

def blocked
  @blocked
end

#charge_nameObject

Provides information on what services the charge item is for. The following table provides a description of the different chargeName values available at this time. | chargeName | Description | | — | — | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |


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

def charge_name
  @charge_name
end

#charge_typeObject

Reserved: TBD


28
29
30
# File 'lib/docusign_esign/models/billing_charge.rb', line 28

def charge_type
  @charge_type
end

#charge_unit_of_measureObject

Reserved: TBD


31
32
33
# File 'lib/docusign_esign/models/billing_charge.rb', line 31

def charge_unit_of_measure
  @charge_unit_of_measure
end

#discountsObject

Returns the value of attribute discounts


34
35
36
# File 'lib/docusign_esign/models/billing_charge.rb', line 34

def discounts
  @discounts
end

#first_effective_dateObject

Returns the value of attribute first_effective_date


37
38
39
# File 'lib/docusign_esign/models/billing_charge.rb', line 37

def first_effective_date
  @first_effective_date
end

#included_quantityObject

Returns the value of attribute included_quantity


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

def included_quantity
  @included_quantity
end

#incremental_quantityObject

Reserved: TBD


43
44
45
# File 'lib/docusign_esign/models/billing_charge.rb', line 43

def incremental_quantity
  @incremental_quantity
end

#last_effective_dateObject

Returns the value of attribute last_effective_date


46
47
48
# File 'lib/docusign_esign/models/billing_charge.rb', line 46

def last_effective_date
  @last_effective_date
end

#pricesObject

Returns the value of attribute prices


49
50
51
# File 'lib/docusign_esign/models/billing_charge.rb', line 49

def prices
  @prices
end

#unit_priceObject

Reserved: TBD


52
53
54
# File 'lib/docusign_esign/models/billing_charge.rb', line 52

def unit_price
  @unit_price
end

#used_quantityObject

Returns the value of attribute used_quantity


55
56
57
# File 'lib/docusign_esign/models/billing_charge.rb', line 55

def used_quantity
  @used_quantity
end

Class Method Details

.attribute_mapObject

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


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

def self.attribute_map
  {
    :'allowed_quantity' => :'allowedQuantity',
    :'blocked' => :'blocked',
    :'charge_name' => :'chargeName',
    :'charge_type' => :'chargeType',
    :'charge_unit_of_measure' => :'chargeUnitOfMeasure',
    :'discounts' => :'discounts',
    :'first_effective_date' => :'firstEffectiveDate',
    :'included_quantity' => :'includedQuantity',
    :'incremental_quantity' => :'incrementalQuantity',
    :'last_effective_date' => :'lastEffectiveDate',
    :'prices' => :'prices',
    :'unit_price' => :'unitPrice',
    :'used_quantity' => :'usedQuantity'
  }
end

.swagger_typesObject

Attribute type mapping.


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

def self.swagger_types
  {
    :'allowed_quantity' => :'String',
    :'blocked' => :'String',
    :'charge_name' => :'String',
    :'charge_type' => :'String',
    :'charge_unit_of_measure' => :'String',
    :'discounts' => :'Array<BillingDiscount>',
    :'first_effective_date' => :'String',
    :'included_quantity' => :'String',
    :'incremental_quantity' => :'String',
    :'last_effective_date' => :'String',
    :'prices' => :'Array<BillingPrice>',
    :'unit_price' => :'String',
    :'used_quantity' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/docusign_esign/models/billing_charge.rb', line 175

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allowed_quantity == o.allowed_quantity &&
      blocked == o.blocked &&
      charge_name == o.charge_name &&
      charge_type == o.charge_type &&
      charge_unit_of_measure == o.charge_unit_of_measure &&
      discounts == o.discounts &&
      first_effective_date == o.first_effective_date &&
      included_quantity == o.included_quantity &&
      incremental_quantity == o.incremental_quantity &&
      last_effective_date == o.last_effective_date &&
      prices == o.prices &&
      unit_price == o.unit_price &&
      used_quantity == o.used_quantity
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


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
263
264
265
# File 'lib/docusign_esign/models/billing_charge.rb', line 229

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


295
296
297
298
299
300
301
302
303
304
305
306
307
# File 'lib/docusign_esign/models/billing_charge.rb', line 295

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


208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/docusign_esign/models/billing_charge.rb', line 208

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

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

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


201
202
203
# File 'lib/docusign_esign/models/billing_charge.rb', line 201

def hash
  [allowed_quantity, blocked, charge_name, charge_type, charge_unit_of_measure, discounts, first_effective_date, included_quantity, incremental_quantity, last_effective_date, prices, unit_price, used_quantity].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


162
163
164
165
# File 'lib/docusign_esign/models/billing_charge.rb', line 162

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


275
276
277
# File 'lib/docusign_esign/models/billing_charge.rb', line 275

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


281
282
283
284
285
286
287
288
289
# File 'lib/docusign_esign/models/billing_charge.rb', line 281

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


269
270
271
# File 'lib/docusign_esign/models/billing_charge.rb', line 269

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


169
170
171
# File 'lib/docusign_esign/models/billing_charge.rb', line 169

def valid?
  true
end