Class: UnivapayClientSdk::ChargeWebhookEvent

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/univapay_client_sdk/models/charge_webhook_event.rb

Overview

Webhook envelope for charge lifecycle events. Fired as charge_updated whenever a charge transitions to a new status (e.g., pending → awaiting), and as charge_finished when a charge reaches a terminal status (successful, failed, error). The data field contains the full Charge object at the time of the event.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(id:, event:, created_on:, data: SKIP, additional_properties: nil) ⇒ ChargeWebhookEvent

Returns a new instance of ChargeWebhookEvent.



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 55

def initialize(id:, event:, created_on:, data: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @id = id
  @event = event
  @data = data unless data == SKIP
  @created_on = created_on
  @additional_properties = additional_properties
end

Instance Attribute Details

#created_on ⇒ DateTime

Timestamp when the event was fired.

Returns:

  • (DateTime) 


31
32
33
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 31

def created_on
  @created_on
end

#data ⇒ Charge

Charge resource returned by the payments API.

Returns:



27
28
29
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 27

def data
  @data
end

#event ⇒ ChargeEvent

Event type discriminator — charge_updated or charge_finished.

Returns:



23
24
25
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 23

def event
  @event
end

#id ⇒ UUID | String

Unique ID of this webhook delivery.

Returns:

  • (UUID | String) 


19
20
21
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 19

def id
  @id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 68

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : nil
  event = hash.key?('event') ? hash['event'] : nil
  created_on = if hash.key?('created_on')
                 (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
               end
  data = Charge.from_hash(hash['data']) if hash['data']

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  ChargeWebhookEvent.new(id: id,
                         event: event,
                         created_on: created_on,
                         data: data,
                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



34
35
36
37
38
39
40
41
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 34

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['event'] = 'event'
  @_hash['data'] = 'data'
  @_hash['created_on'] = 'created_on'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



51
52
53
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 51

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



44
45
46
47
48
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 44

def self.optionals
  %w[
    data
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 100

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.id,
                            ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.event,
                              ->(val) { ChargeEvent.validate(val) }) and
        APIHelper.valid_type?(value.created_on,
                              ->(val) { val.instance_of? DateTime })
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['id'],
                          ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['event'],
                            ->(val) { ChargeEvent.validate(val) }) and
      APIHelper.valid_type?(value['created_on'],
                            ->(val) { val.instance_of? String })
  )
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



132
133
134
135
136
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 132

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id.inspect}, event: #{@event.inspect}, data: #{@data.inspect},"\
  " created_on: #{@created_on.inspect}, additional_properties: #{@additional_properties}>"
end

#to_custom_created_on ⇒ Object 



94
95
96
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 94

def to_custom_created_on
  DateTimeHelper.to_rfc3339(created_on)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



125
126
127
128
129
 
# File 'lib/univapay_client_sdk/models/charge_webhook_event.rb', line 125

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id}, event: #{@event}, data: #{@data}, created_on: #{@created_on},"\
  " additional_properties: #{@additional_properties}>"
end