Class: PostfinancecheckoutRubySdk::WebhookListenerCreate

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookListenerCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 121

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::WebhookListenerCreate` 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::WebhookListenerCreate`. 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?(:'entity_states')
    if (value = attributes[:'entity_states']).is_a?(Array)
      self.entity_states = value
    end
  end

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

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

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

Instance Attribute Details

#entity ⇒ Object

The entity that is to be monitored.



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

def entity
  @entity
end

#entity_states ⇒ Object

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



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

def entity_states
  @entity_states
end

#identity ⇒ Object

The identity used to sign messages.



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

def identity
  @identity
end

#name ⇒ Object

The name used to identify the webhook listener.



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

def name
  @name
end

#notify_every_change ⇒ Object

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



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

def notify_every_change
  @notify_every_change
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#url ⇒ Object

The URL where notifications about entity changes are sent to.



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

def url
  @url
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



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
332
333
334
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 297

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



84
85
86
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 84

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 89

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 71

def self.attribute_map
  {
    :'entity_states' => :'entityStates',
    :'name' => :'name',
    :'state' => :'state',
    :'notify_every_change' => :'notifyEveryChange',
    :'identity' => :'identity',
    :'entity' => :'entity',
    :'url' => :'url'
  }
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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 273

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'AbstractWebhookListenerUpdate'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 94

def self.openapi_types
  {
    :'entity_states' => :'Array<String>',
    :'name' => :'String',
    :'state' => :'CreationEntityState',
    :'notify_every_change' => :'Boolean',
    :'identity' => :'Integer',
    :'entity' => :'Integer',
    :'url' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 246

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 368

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


260
261
262
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [entity_states, name, state, notify_every_change, identity, 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



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

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

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

  if @url.nil?
    invalid_properties.push('invalid value for "url", url cannot be nil.')
  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



344
345
346
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 344

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



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

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



338
339
340
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 338

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



192
193
194
195
196
197
198
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_listener_create.rb', line 192

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