Class: PostFinanceCheckout::WebhookUrl

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookUrl

Initializes the object

Parameters:

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

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_url.rb', line 77

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

#application_managed ⇒ Object

Whether the webhook URL is managed by the application, and therefore cannot be changed via the user interface.



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

def application_managed
  @application_managed
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

The name used to identify the webhook URL.



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

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



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

def planned_purge_date
  @planned_purge_date
end

#state ⇒ Object

The object’s current state.



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

def state
  @state
end

#url ⇒ Object

The actual URL where notifications about entity changes are sent to.



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

def url
  @url
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_url.rb', line 48

def self.attribute_map
  {
    :'application_managed' => :'applicationManaged',
    :'id' => :'id',
    :'linked_space_id' => :'linkedSpaceId',
    :'name' => :'name',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'state' => :'state',
    :'url' => :'url',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_url.rb', line 62

def self.swagger_types
  {
    :'application_managed' => :'BOOLEAN',
    :'id' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'name' => :'String',
    :'planned_purge_date' => :'DateTime',
    :'state' => :'CreationEntityState',
    :'url' => :'String',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_url.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      application_managed == o.application_managed &&
      id == o.id &&
      linked_space_id == o.linked_space_id &&
      name == o.name &&
      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



219
220
221
222
223
224
225
226
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_url.rb', line 219

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_url.rb', line 285

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_url.rb', line 198

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


185
186
187
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_url.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_url.rb', line 191

def hash
  [application_managed, id, linked_space_id, name, 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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_url.rb', line 118

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

  if !@url.nil? && @url.to_s.length > 500
    invalid_properties.push('invalid value for "url", the character length must be smaller than or equal to 500.')
  end

  if !@url.nil? && @url.to_s.length < 9
    invalid_properties.push('invalid value for "url", the character length must be great than or equal to 9.')
  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



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

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



271
272
273
274
275
276
277
278
279
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_url.rb', line 271

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



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

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



137
138
139
140
141
142
 
# File 'lib/postfinancecheckout-ruby-sdk/models/webhook_url.rb', line 137

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