Class: PostFinanceCheckout::WebhookListener

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookListener

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 92

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

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

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

  if attributes.has_key?(:'identity')
    self.identity = attributes[:'identity']
  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?(:'notifyEveryChange')
    self.notify_every_change = attributes[:'notifyEveryChange']
  end

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

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

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

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

Instance Attribute Details

#entity ⇒ Object

The listener listens on state changes of the entity linked with the listener.



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

def entity
  @entity
end

#entity_states ⇒ Object

The target state identifies the state into which entities need to move into to trigger the webhook listener.



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

def entity_states
  @entity_states
end

#id ⇒ Object

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



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

def id
  @id
end

#identity ⇒ Object

The identity which will be used to sign messages sent by this listener.



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

def identity
  @identity
end

#linked_space_id ⇒ Object

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



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

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

The webhook listener name is used internally to identify the webhook listener in administrative interfaces.For example it is used within search fields and hence it should be distinct and descriptive.



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

def name
  @name
end

#notify_every_change ⇒ Object

Defines whether the webhook listener is to be informed about every change made to the entity in contrast to state transitions only.



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

def notify_every_change
  @notify_every_change
end

#planned_purge_date ⇒ Object

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.



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

def planned_purge_date
  @planned_purge_date
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#url ⇒ Object

The URL which is invoked by the listener to notify the application about the event.



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

def url
  @url
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 57

def self.attribute_map
  {
    :'entity' => :'entity',
    :'entity_states' => :'entityStates',
    :'id' => :'id',
    :'identity' => :'identity',
    :'linked_space_id' => :'linkedSpaceId',
    :'name' => :'name',
    :'notify_every_change' => :'notifyEveryChange',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'state' => :'state',
    :'url' => :'url',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 74

def self.swagger_types
  {
    :'entity' => :'Integer',
    :'entity_states' => :'Array<String>',
    :'id' => :'Integer',
    :'identity' => :'WebhookIdentity',
    :'linked_space_id' => :'Integer',
    :'name' => :'String',
    :'notify_every_change' => :'BOOLEAN',
    :'planned_purge_date' => :'DateTime',
    :'state' => :'CreationEntityState',
    :'url' => :'WebhookUrl',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 175

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      entity == o.entity &&
      entity_states == o.entity_states &&
      id == o.id &&
      identity == o.identity &&
      linked_space_id == o.linked_space_id &&
      name == o.name &&
      notify_every_change == o.notify_every_change &&
      planned_purge_date == o.planned_purge_date &&
      state == o.state &&
      url == o.url &&
      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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 227

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 293

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 206

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


193
194
195
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 193

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



199
200
201
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 199

def hash
  [entity, entity_states, id, identity, linked_space_id, name, notify_every_change, planned_purge_date, state, url, 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



147
148
149
150
151
152
153
154
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 147

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



273
274
275
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 273

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



279
280
281
282
283
284
285
286
287
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 279

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



267
268
269
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 267

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



158
159
160
161
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener.rb', line 158

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