Class: PostfinancecheckoutRubySdk::PaymentConnectorConfiguration

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentConnectorConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 151

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::PaymentConnectorConfiguration` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PostfinancecheckoutRubySdk::PaymentConnectorConfiguration`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'payment_method_configuration')
    self.payment_method_configuration = attributes[:'payment_method_configuration']
  end

  if attributes.key?(:'image_path')
    self.image_path = attributes[:'image_path']
  end

  if attributes.key?(:'planned_purge_date')
    self.planned_purge_date = attributes[:'planned_purge_date']
  end

  if attributes.key?(:'priority')
    self.priority = attributes[:'priority']
  end

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

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

  if attributes.key?(:'processor_configuration')
    self.processor_configuration = attributes[:'processor_configuration']
  end

  if attributes.key?(:'linked_space_id')
    self.linked_space_id = attributes[:'linked_space_id']
  end

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

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

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

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

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

  if attributes.key?(:'applicable_for_transaction_processing')
    self.applicable_for_transaction_processing = attributes[:'applicable_for_transaction_processing']
  end

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

Instance Attribute Details

#applicable_for_transaction_processing ⇒ Object

Whether this connector configuration is enabled for processing payments, taking into account the state of the processor and payment method configurations.



64
65
66
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 64

def applicable_for_transaction_processing
  @applicable_for_transaction_processing
end

#conditions ⇒ Object

Conditions allow to define criteria that a transaction must fulfill in order for the connector configuration to be considered for processing the payment.



67
68
69
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 67

def conditions
  @conditions
end

#connector ⇒ Object

Returns the value of attribute connector.



50
51
52
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 50

def connector
  @connector
end

#enabled_sales_channels ⇒ Object

The sales channels for which the connector configuration is enabled. If empty, it is enabled for all sales channels.



40
41
42
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 40

def enabled_sales_channels
  @enabled_sales_channels
end

#enabled_space_views ⇒ Object

The space views for which the connector configuration is enabled. If empty, it is enabled for all space views.



56
57
58
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 56

def enabled_space_views
  @enabled_space_views
end

#id ⇒ Object

A unique identifier for the object.



59
60
61
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 59

def id
  @id
end

#image_path ⇒ Object

The URL to the connector’s image.



31
32
33
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 31

def image_path
  @image_path
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

The name used to identify the connector configuration.



53
54
55
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 53

def name
  @name
end

#payment_method_configuration ⇒ Object

Returns the value of attribute payment_method_configuration.



28
29
30
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 28

def payment_method_configuration
  @payment_method_configuration
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



34
35
36
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 34

def planned_purge_date
  @planned_purge_date
end

#priority ⇒ Object

The priority that determines the order in which connector configurations are taken into account when processing a payment. Low values are considered first.



37
38
39
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 37

def priority
  @priority
end

#processor_configuration ⇒ Object

Returns the value of attribute processor_configuration.



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

def processor_configuration
  @processor_configuration
end

#state ⇒ Object

Returns the value of attribute state.



61
62
63
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 61

def state
  @state
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



43
44
45
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 43

def version
  @version
end

Class Method Details

._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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 347

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = PostfinancecheckoutRubySdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



113
114
115
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 113

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



118
119
120
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 118

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 92

def self.attribute_map
  {
    :'payment_method_configuration' => :'paymentMethodConfiguration',
    :'image_path' => :'imagePath',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'priority' => :'priority',
    :'enabled_sales_channels' => :'enabledSalesChannels',
    :'version' => :'version',
    :'processor_configuration' => :'processorConfiguration',
    :'linked_space_id' => :'linkedSpaceId',
    :'connector' => :'connector',
    :'name' => :'name',
    :'enabled_space_views' => :'enabledSpaceViews',
    :'id' => :'id',
    :'state' => :'state',
    :'applicable_for_transaction_processing' => :'applicableForTransactionProcessing',
    :'conditions' => :'conditions'
  }
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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 323

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



144
145
146
147
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 144

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 123

def self.openapi_types
  {
    :'payment_method_configuration' => :'PaymentMethodConfiguration',
    :'image_path' => :'String',
    :'planned_purge_date' => :'Time',
    :'priority' => :'Integer',
    :'enabled_sales_channels' => :'Array<SalesChannel>',
    :'version' => :'Integer',
    :'processor_configuration' => :'PaymentProcessorConfiguration',
    :'linked_space_id' => :'Integer',
    :'connector' => :'PaymentConnector',
    :'name' => :'String',
    :'enabled_space_views' => :'Array<Integer>',
    :'id' => :'Integer',
    :'state' => :'CreationEntityState',
    :'applicable_for_transaction_processing' => :'Boolean',
    :'conditions' => :'Array<Condition>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 288

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_method_configuration == o.payment_method_configuration &&
      image_path == o.image_path &&
      planned_purge_date == o.planned_purge_date &&
      priority == o.priority &&
      enabled_sales_channels == o.enabled_sales_channels &&
      version == o.version &&
      processor_configuration == o.processor_configuration &&
      linked_space_id == o.linked_space_id &&
      connector == o.connector &&
      name == o.name &&
      enabled_space_views == o.enabled_space_views &&
      id == o.id &&
      state == o.state &&
      applicable_for_transaction_processing == o.applicable_for_transaction_processing &&
      conditions == o.conditions
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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 418

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [payment_method_configuration, image_path, planned_purge_date, priority, enabled_sales_channels, version, processor_configuration, linked_space_id, connector, name, enabled_space_views, id, state, applicable_for_transaction_processing, conditions].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



234
235
236
237
238
239
240
241
242
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 234

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



394
395
396
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 394

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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 400

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



388
389
390
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 388

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



246
247
248
249
250
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_connector_configuration.rb', line 246

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@name.nil? && @name.to_s.length > 100
  true
end