Class: WalleeRubySdk::WebhookListener

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

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 130

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#enable_payload_signature_and_state ⇒ Object

Whether signature header and ‘state’ property are enabled in webhook payload.



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

def enable_payload_signature_and_state
  @enable_payload_signature_and_state
end

#entity ⇒ Object

The entity that is to be monitored.



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

def entity
  @entity
end

#entity_states ⇒ Object

The entity’s target states that are to be monitored.



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

def entity_states
  @entity_states
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#identity ⇒ Object

Returns the value of attribute identity.



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

def identity
  @identity
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

The name used to identify the webhook listener.



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

def name
  @name
end

#notify_every_change ⇒ Object

Whether every update of the entity or only state changes are to be monitored.



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

def notify_every_change
  @notify_every_change
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.



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

def planned_purge_date
  @planned_purge_date
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

#version ⇒ Object

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



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

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



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
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 294

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 = WalleeRubySdk.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_attributes ⇒ Object

Returns all the JSON keys this model knows about



100
101
102
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 100

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 82

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

.build_from_hash(attributes) ⇒ Object

Returns the model itself

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 270

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



123
124
125
126
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 123

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

.openapi_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 105

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 240

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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 365

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


259
260
261
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 265

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



196
197
198
199
200
201
202
203
204
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 196

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



341
342
343
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 341

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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 347

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



335
336
337
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 335

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



208
209
210
211
212
 
# File 'lib/wallee-ruby-sdk/models/webhook_listener.rb', line 208

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