Class: DocuSign_eSign::PaymentGatewayAccount

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

Overview

This object contains details about a payment gateway account.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentGatewayAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 101

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allow_custom_metadata ⇒ Object

Returns the value of attribute allow_custom_metadata.



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

def allow_custom_metadata
  @allow_custom_metadata
end

#config ⇒ Object

This property contains metadata about the payment gateway account’s configuration such as the API key, ‘userId`, and `merchantId` details.



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

def config
  @config
end

#display_name ⇒ Object

Returns the value of attribute display_name.



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

def display_name
  @display_name
end

#is_enabled ⇒ Object

Returns the value of attribute is_enabled.



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

def is_enabled
  @is_enabled
end

#is_legacy ⇒ Object

Returns the value of attribute is_legacy.



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

def is_legacy
  @is_legacy
end

#last_modified ⇒ Object

Returns the value of attribute last_modified.



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

def last_modified
  @last_modified
end

#pay_pal_legacy_settings ⇒ Object

Reserved for DocuSign.



45
46
47
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 45

def pay_pal_legacy_settings
  @pay_pal_legacy_settings
end

#payment_gateway ⇒ Object

Returns the value of attribute payment_gateway.



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

def payment_gateway
  @payment_gateway
end

#payment_gateway_account_id ⇒ Object

Returns the value of attribute payment_gateway_account_id.



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

def 
  @payment_gateway_account_id
end

#payment_gateway_display_name ⇒ Object

Returns the value of attribute payment_gateway_display_name.



42
43
44
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 42

def payment_gateway_display_name
  @payment_gateway_display_name
end

#supported_currencies ⇒ Object

Returns the value of attribute supported_currencies.



48
49
50
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 48

def supported_currencies
  @supported_currencies
end

#supported_payment_methods ⇒ Object

Returns the value of attribute supported_payment_methods.



51
52
53
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 51

def supported_payment_methods
  @supported_payment_methods
end

#supported_payment_methods_with_options ⇒ Object

Returns the value of attribute supported_payment_methods_with_options.



54
55
56
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 54

def supported_payment_methods_with_options
  @supported_payment_methods_with_options
end

#zero_decimal_currencies ⇒ Object

Returns the value of attribute zero_decimal_currencies.



57
58
59
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 57

def zero_decimal_currencies
  @zero_decimal_currencies
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 60

def self.attribute_map
  {
    :'allow_custom_metadata' => :'allowCustomMetadata',
    :'config' => :'config',
    :'display_name' => :'displayName',
    :'is_enabled' => :'isEnabled',
    :'is_legacy' => :'isLegacy',
    :'last_modified' => :'lastModified',
    :'payment_gateway' => :'paymentGateway',
    :'payment_gateway_account_id' => :'paymentGatewayAccountId',
    :'payment_gateway_display_name' => :'paymentGatewayDisplayName',
    :'pay_pal_legacy_settings' => :'payPalLegacySettings',
    :'supported_currencies' => :'supportedCurrencies',
    :'supported_payment_methods' => :'supportedPaymentMethods',
    :'supported_payment_methods_with_options' => :'supportedPaymentMethodsWithOptions',
    :'zero_decimal_currencies' => :'zeroDecimalCurrencies'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 80

def self.swagger_types
  {
    :'allow_custom_metadata' => :'BOOLEAN',
    :'config' => :'PaymentGatewayAccountSetting',
    :'display_name' => :'String',
    :'is_enabled' => :'String',
    :'is_legacy' => :'String',
    :'last_modified' => :'String',
    :'payment_gateway' => :'String',
    :'payment_gateway_account_id' => :'String',
    :'payment_gateway_display_name' => :'String',
    :'pay_pal_legacy_settings' => :'PayPalLegacySettings',
    :'supported_currencies' => :'Array<String>',
    :'supported_payment_methods' => :'Array<String>',
    :'supported_payment_methods_with_options' => :'Array<PaymentMethodWithOptions>',
    :'zero_decimal_currencies' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_custom_metadata == o.allow_custom_metadata &&
      config == o.config &&
      display_name == o.display_name &&
      is_enabled == o.is_enabled &&
      is_legacy == o.is_legacy &&
      last_modified == o.last_modified &&
      payment_gateway == o.payment_gateway &&
       == o. &&
      payment_gateway_display_name == o.payment_gateway_display_name &&
      pay_pal_legacy_settings == o.pay_pal_legacy_settings &&
      supported_currencies == o.supported_currencies &&
      supported_payment_methods == o.supported_payment_methods &&
      supported_payment_methods_with_options == o.supported_payment_methods_with_options &&
      zero_decimal_currencies == o.zero_decimal_currencies
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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 242

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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 308

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 221

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [allow_custom_metadata, config, display_name, is_enabled, is_legacy, last_modified, payment_gateway, , payment_gateway_display_name, pay_pal_legacy_settings, supported_currencies, supported_payment_methods, supported_payment_methods_with_options, zero_decimal_currencies].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



174
175
176
177
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 174

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



288
289
290
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 288

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



294
295
296
297
298
299
300
301
302
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 294

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



282
283
284
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 282

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



181
182
183
 
# File 'lib/docusign_esign/models/payment_gateway_account.rb', line 181

def valid?
  true
end