Class: WhiteLabelMachineName::PaymentAppConnector

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentAppConnector

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

  if attributes.has_key?(:'linkedSpaceId')
    self.linked_space_id = attributes[:'linkedSpaceId']
  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?(:'processor')
    self.processor = attributes[:'processor']
  end

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

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

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

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

Instance Attribute Details

#authorization_timeout ⇒ Object

Returns the value of attribute authorization_timeout.



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

def authorization_timeout
  @authorization_timeout
end

#completion_configuration ⇒ Object

The completion configuration defines how the deferred completion is processed. If it is not present it means that deferred completion is not supported by this connector.



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

def completion_configuration
  @completion_configuration
end

#connector_configuration ⇒ Object

The connector configuration references the configuration that was created as part of this connector within the space. The connector configuration is referenced within transactions created with this connector.



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

def connector_configuration
  @connector_configuration
end

#created_on ⇒ Object

The created on date indicates when the connector was added.



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

def created_on
  @created_on
end

#external_id ⇒ Object

The external ID corresponds to the ID provided during inserting of the processor.



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

def external_id
  @external_id
end

#id ⇒ Object

The ID is the primary key of the entity. The ID identifies the entity uniquely.



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

def id
  @id
end

#linked_space_id ⇒ Object

The linked space id holds the ID of the space to which the entity belongs to.



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

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

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



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

def name
  @name
end

#payment_page_endpoint ⇒ Object

The payment page endpoint is invoked to process the transaction. The endpoint is defined by the external service provider.



48
49
50
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 48

def payment_page_endpoint
  @payment_page_endpoint
end

#processor ⇒ Object

The processor references the app processor to which this connector belongs to. The relationship is established during the creation of the connector.



51
52
53
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 51

def processor
  @processor
end

#refund_configuration ⇒ Object

The refund configuration defines how refunds are processed. If it is not present it means that refunds are not supported by this connector.



54
55
56
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 54

def refund_configuration
  @refund_configuration
end

#state ⇒ Object

Returns the value of attribute state.



57
58
59
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 57

def state
  @state
end

#updated_on ⇒ Object

The updated on date indicates when the last time the connector was updated on.



60
61
62
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 60

def updated_on
  @updated_on
end

#version ⇒ Object

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.



63
64
65
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 63

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 66

def self.attribute_map
  {
    :'authorization_timeout' => :'authorizationTimeout',
    :'completion_configuration' => :'completionConfiguration',
    :'connector_configuration' => :'connectorConfiguration',
    :'created_on' => :'createdOn',
    :'external_id' => :'externalId',
    :'id' => :'id',
    :'linked_space_id' => :'linkedSpaceId',
    :'name' => :'name',
    :'payment_page_endpoint' => :'paymentPageEndpoint',
    :'processor' => :'processor',
    :'refund_configuration' => :'refundConfiguration',
    :'state' => :'state',
    :'updated_on' => :'updatedOn',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 86

def self.swagger_types
  {
    :'authorization_timeout' => :'String',
    :'completion_configuration' => :'PaymentAppCompletionConfiguration',
    :'connector_configuration' => :'PaymentConnectorConfiguration',
    :'created_on' => :'DateTime',
    :'external_id' => :'String',
    :'id' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'name' => :'String',
    :'payment_page_endpoint' => :'String',
    :'processor' => :'PaymentAppProcessor',
    :'refund_configuration' => :'PaymentAppRefundConfiguration',
    :'state' => :'PaymentAppConnectorState',
    :'updated_on' => :'DateTime',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authorization_timeout == o.authorization_timeout &&
      completion_configuration == o.completion_configuration &&
      connector_configuration == o.connector_configuration &&
      created_on == o.created_on &&
      external_id == o.external_id &&
      id == o.id &&
      linked_space_id == o.linked_space_id &&
      name == o.name &&
      payment_page_endpoint == o.payment_page_endpoint &&
      processor == o.processor &&
      refund_configuration == o.refund_configuration &&
      state == o.state &&
      updated_on == o.updated_on &&
      version == o.version
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 270

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 336

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 249

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


236
237
238
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 236

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



242
243
244
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 242

def hash
  [authorization_timeout, completion_configuration, connector_configuration, created_on, external_id, id, linked_space_id, name, payment_page_endpoint, processor, refund_configuration, state, updated_on, version].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



172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 172

def list_invalid_properties
  invalid_properties = Array.new
  if !@external_id.nil? && @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 !@name.nil? && @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  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



316
317
318
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 316

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



322
323
324
325
326
327
328
329
330
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 322

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



310
311
312
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 310

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



187
188
189
190
191
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_app_connector.rb', line 187

def valid?
  return false if !@external_id.nil? && @external_id.to_s.length > 40
  return false if !@name.nil? && @name.to_s.length > 100
  true
end