Class: UnivapayClientSdk::SubscriptionWebhookEvent

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

Overview

Webhook envelope for subscription lifecycle events. Fired as subscription_created when a subscription is created and its first payment initiated, subscription_payment when a scheduled payment processes successfully, subscription_completed when all scheduled payments complete, subscription_failure when a scheduled payment fails, subscription_canceled when a subscription is cancelled before all payments complete, and subscription_suspended when a subscription is paused. The data field contains the full Subscription 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) ⇒ SubscriptionWebhookEvent

Returns a new instance of SubscriptionWebhookEvent.



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 60

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) 


36
37
38
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 36

def created_on
  @created_on
end

#data ⇒ Subscription

The Subscription object represents a recurring payment schedule.

Returns:



32
33
34
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 32

def data
  @data
end

#event ⇒ SubscriptionEvent

Event type discriminator — subscription_created, subscription_payment, subscription_completed, subscription_failure, subscription_canceled, or subscription_suspended.

Returns:



28
29
30
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 28

def event
  @event
end

#id ⇒ UUID | String

Unique ID of this webhook delivery.

Returns:

  • (UUID | String) 


22
23
24
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 22

def id
  @id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 73

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 = Subscription.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.
  SubscriptionWebhookEvent.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.



39
40
41
42
43
44
45
46
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 39

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



56
57
58
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 56

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



49
50
51
52
53
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 49

def self.optionals
  %w[
    data
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 105

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) { SubscriptionEvent.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) { SubscriptionEvent.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.



137
138
139
140
141
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 137

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 



99
100
101
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 99

def to_custom_created_on
  DateTimeHelper.to_rfc3339(created_on)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



130
131
132
133
134
 
# File 'lib/univapay_client_sdk/models/subscription_webhook_event.rb', line 130

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