Class: WhiteLabelMachineName::PaymentAppConnectorCreationRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentAppConnectorCreationRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
109
110
111
112
113
114
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 77

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

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

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

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

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

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

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

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

Instance Attribute Details

#authorization_timeout_in_minutes ⇒ Object

When the transaction is not authorized within this timeout the transaction is considered as failed.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 24

def authorization_timeout_in_minutes
  @authorization_timeout_in_minutes
end

#completion_configuration ⇒ Object

The completion configuration allows the connector to support deferred completions on a transaction. If it is not provided the connector will not process transactions in deferred mode.



27
28
29
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 27

def completion_configuration
  @completion_configuration
end

#connector ⇒ Object

The ID of the connector identifies which connector that should be linked with this web app connector. The connector defines the payment method.



30
31
32
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 30

def connector
  @connector
end

#external_id ⇒ Object

The external ID identifies the connector within the external system. It has to be unique per processor external ID and for any subsequent update the same ID must be sent.



33
34
35
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 33

def external_id
  @external_id
end

#name ⇒ Object

The name of the connector will be displayed within the user interfaces that the merchant is interacting with.



36
37
38
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 36

def name
  @name
end

#payment_page_endpoint ⇒ Object

The payment page endpoint URL will be invoked by the buyer to carry out the authorization of the payment.



39
40
41
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 39

def payment_page_endpoint
  @payment_page_endpoint
end

#processor_external_id ⇒ Object

The external ID of the processor identifies the processor to which this connector belongs to. The processor cannot be changed once it has been set on a connector.



42
43
44
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 42

def processor_external_id
  @processor_external_id
end

#refund_configuration ⇒ Object

The refund configuration allows the connector to support refunds on transactions. In case no refund configuration is provided the connector will not support refunds.



45
46
47
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 45

def refund_configuration
  @refund_configuration
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 48

def self.attribute_map
  {
    :'authorization_timeout_in_minutes' => :'authorizationTimeoutInMinutes',
    :'completion_configuration' => :'completionConfiguration',
    :'connector' => :'connector',
    :'external_id' => :'externalId',
    :'name' => :'name',
    :'payment_page_endpoint' => :'paymentPageEndpoint',
    :'processor_external_id' => :'processorExternalId',
    :'refund_configuration' => :'refundConfiguration'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 62

def self.swagger_types
  {
    :'authorization_timeout_in_minutes' => :'Integer',
    :'completion_configuration' => :'PaymentAppCompletionConfigurationCreate',
    :'connector' => :'Integer',
    :'external_id' => :'String',
    :'name' => :'String',
    :'payment_page_endpoint' => :'String',
    :'processor_external_id' => :'String',
    :'refund_configuration' => :'PaymentAppRefundConfigurationCreate'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 236

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authorization_timeout_in_minutes == o.authorization_timeout_in_minutes &&
      completion_configuration == o.completion_configuration &&
      connector == o.connector &&
      external_id == o.external_id &&
      name == o.name &&
      payment_page_endpoint == o.payment_page_endpoint &&
      processor_external_id == o.processor_external_id &&
      refund_configuration == o.refund_configuration
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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 285

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 = WhiteLabelMachineName.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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 351

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 264

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


251
252
253
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



257
258
259
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 257

def hash
  [authorization_timeout_in_minutes, completion_configuration, connector, external_id, name, payment_page_endpoint, processor_external_id, refund_configuration].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



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 118

def list_invalid_properties
  invalid_properties = Array.new
  if @authorization_timeout_in_minutes.nil?
    invalid_properties.push('invalid value for "authorization_timeout_in_minutes", authorization_timeout_in_minutes cannot be nil.')
  end

  if @connector.nil?
    invalid_properties.push('invalid value for "connector", connector cannot be nil.')
  end

  if @external_id.nil?
    invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
  end

  if @external_id.to_s.length > 40
    invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 40.')
  end

  if @external_id.to_s.length < 1
    invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  end

  if @payment_page_endpoint.nil?
    invalid_properties.push('invalid value for "payment_page_endpoint", payment_page_endpoint cannot be nil.')
  end

  if @processor_external_id.nil?
    invalid_properties.push('invalid value for "processor_external_id", processor_external_id cannot be nil.')
  end

  if @processor_external_id.to_s.length > 40
    invalid_properties.push('invalid value for "processor_external_id", the character length must be smaller than or equal to 40.')
  end

  if @processor_external_id.to_s.length < 1
    invalid_properties.push('invalid value for "processor_external_id", the character length must be great than or equal to 1.')
  end

  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



331
332
333
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 331

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



337
338
339
340
341
342
343
344
345
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 337

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



325
326
327
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 325

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
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector_creation_request.rb', line 169

def valid?
  return false if @authorization_timeout_in_minutes.nil?
  return false if @connector.nil?
  return false if @external_id.nil?
  return false if @external_id.to_s.length > 40
  return false if @external_id.to_s.length < 1
  return false if @name.nil?
  return false if @name.to_s.length > 100
  return false if @payment_page_endpoint.nil?
  return false if @processor_external_id.nil?
  return false if @processor_external_id.to_s.length > 40
  return false if @processor_external_id.to_s.length < 1
  true
end