Class: DocuSign_eSign::PaymentDetails

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/docusign_esign/models/payment_details.rb', line 108

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?(:'allowedPaymentMethods')
    if (value = attributes[:'allowedPaymentMethods']).is_a?(Array)
      self.allowed_payment_methods = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allowed_payment_methodsObject

Returns the value of attribute allowed_payment_methods


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

def allowed_payment_methods
  @allowed_payment_methods
end

#charge_idObject

Returns the value of attribute charge_id


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

def charge_id
  @charge_id
end

#currency_codeObject

Returns the value of attribute currency_code


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

def currency_code
  @currency_code
end

#currency_code_metadataObject

Returns the value of attribute currency_code_metadata


26
27
28
# File 'lib/docusign_esign/models/payment_details.rb', line 26

def 
  @currency_code_metadata
end

#custom_metadataObject

Returns the value of attribute custom_metadata


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

def 
  @custom_metadata
end

#custom_metadata_requiredObject

Returns the value of attribute custom_metadata_required


35
36
37
# File 'lib/docusign_esign/models/payment_details.rb', line 35

def 
  @custom_metadata_required
end

#customer_idObject

Returns the value of attribute customer_id


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

def customer_id
  @customer_id
end

#gateway_account_idObject

Returns the value of attribute gateway_account_id


38
39
40
# File 'lib/docusign_esign/models/payment_details.rb', line 38

def 
  @gateway_account_id
end

#gateway_account_id_metadataObject

Returns the value of attribute gateway_account_id_metadata


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

def 
  @gateway_account_id_metadata
end

#gateway_display_nameObject

Returns the value of attribute gateway_display_name


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

def gateway_display_name
  @gateway_display_name
end

#gateway_nameObject

Returns the value of attribute gateway_name


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

def gateway_name
  @gateway_name
end

#line_itemsObject

Returns the value of attribute line_items


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

def line_items
  @line_items
end

#payment_optionObject

Returns the value of attribute payment_option


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

def payment_option
  @payment_option
end

#payment_source_idObject

Returns the value of attribute payment_source_id


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

def payment_source_id
  @payment_source_id
end

#statusObject

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.


58
59
60
# File 'lib/docusign_esign/models/payment_details.rb', line 58

def status
  @status
end

#totalObject

Returns the value of attribute total


60
61
62
# File 'lib/docusign_esign/models/payment_details.rb', line 60

def total
  @total
end

Class Method Details

.attribute_mapObject

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


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/docusign_esign/models/payment_details.rb', line 63

def self.attribute_map
  {
    :'allowed_payment_methods' => :'allowedPaymentMethods',
    :'charge_id' => :'chargeId',
    :'currency_code' => :'currencyCode',
    :'currency_code_metadata' => :'currencyCodeMetadata',
    :'customer_id' => :'customerId',
    :'custom_metadata' => :'customMetadata',
    :'custom_metadata_required' => :'customMetadataRequired',
    :'gateway_account_id' => :'gatewayAccountId',
    :'gateway_account_id_metadata' => :'gatewayAccountIdMetadata',
    :'gateway_display_name' => :'gatewayDisplayName',
    :'gateway_name' => :'gatewayName',
    :'line_items' => :'lineItems',
    :'payment_option' => :'paymentOption',
    :'payment_source_id' => :'paymentSourceId',
    :'status' => :'status',
    :'total' => :'total'
  }
end

.swagger_typesObject

Attribute type mapping.


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/docusign_esign/models/payment_details.rb', line 85

def self.swagger_types
  {
    :'allowed_payment_methods' => :'Array<String>',
    :'charge_id' => :'String',
    :'currency_code' => :'String',
    :'currency_code_metadata' => :'PropertyMetadata',
    :'customer_id' => :'String',
    :'custom_metadata' => :'String',
    :'custom_metadata_required' => :'BOOLEAN',
    :'gateway_account_id' => :'String',
    :'gateway_account_id_metadata' => :'PropertyMetadata',
    :'gateway_display_name' => :'String',
    :'gateway_name' => :'String',
    :'line_items' => :'Array<PaymentLineItem>',
    :'payment_option' => :'String',
    :'payment_source_id' => :'String',
    :'status' => :'String',
    :'total' => :'Money'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/docusign_esign/models/payment_details.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allowed_payment_methods == o.allowed_payment_methods &&
      charge_id == o.charge_id &&
      currency_code == o.currency_code &&
       == o. &&
      customer_id == o.customer_id &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
      gateway_display_name == o.gateway_display_name &&
      gateway_name == o.gateway_name &&
      line_items == o.line_items &&
      payment_option == o.payment_option &&
      payment_source_id == o.payment_source_id &&
      status == o.status &&
      total == o.total
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


255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
# File 'lib/docusign_esign/models/payment_details.rb', line 255

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


321
322
323
324
325
326
327
328
329
330
331
332
333
# File 'lib/docusign_esign/models/payment_details.rb', line 321

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


234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/docusign_esign/models/payment_details.rb', line 234

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

221
222
223
# File 'lib/docusign_esign/models/payment_details.rb', line 221

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


227
228
229
# File 'lib/docusign_esign/models/payment_details.rb', line 227

def hash
  [allowed_payment_methods, charge_id, currency_code, , customer_id, , , , , gateway_display_name, gateway_name, line_items, payment_option, payment_source_id, status, total].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


185
186
187
188
# File 'lib/docusign_esign/models/payment_details.rb', line 185

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


301
302
303
# File 'lib/docusign_esign/models/payment_details.rb', line 301

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


307
308
309
310
311
312
313
314
315
# File 'lib/docusign_esign/models/payment_details.rb', line 307

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


295
296
297
# File 'lib/docusign_esign/models/payment_details.rb', line 295

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


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

def valid?
  true
end