Class: Bitpesa::Webhook

Inherits:
Object
  • Object
show all
Defined in:
lib/bitpesa-sdk/models/webhook.rb

Overview

Whenever objects in the BitPesa API change state, we can optionally send the changed details to a pre-registered webhook address. Webhooks can be created either using the [developer portal](developers.bitpesa.co), or using the [BitPesa API](#operations-tag-Webhooks). Whenever possible we prefer using webhooks to listen on events (for example when a transaction has been paid out) instead of polling the status, and we expect implementations fully utilising webhooks. Webhooks will always generate a ‘POST` request to the specified endpoint, and will also include the same authentication headers as described in the [authentication documentation](github.com/bitpesa/api-documentation/blob/master/authentication.md), so their validity can be verified on the receiver end.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Webhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 47

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

  if attributes.has_key?(:'event')
    self.event = attributes[:'event']
  end

  if attributes.has_key?(:'object')
    self.object = attributes[:'object']
  end
end

Instance Attribute Details

#event ⇒ Object

The event that triggered this webhook



22
23
24
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 22

def event
  @event
end

#object ⇒ Object

The returned object



25
26
27
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 25

def object
  @object
end

#webhook ⇒ Object

The ID of the webhook that was used to send out this callback



19
20
21
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 19

def webhook
  @webhook
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 28

def self.attribute_map
  {
    :'webhook' => :'webhook',
    :'event' => :'event',
    :'object' => :'object'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 37

def self.openapi_types
  {
    :'webhook' => :'String',
    :'event' => :'String',
    :'object' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



96
97
98
99
100
101
102
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 96

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      webhook == o.webhook &&
      event == o.event &&
      object == o.object
end

#[](key) ⇒ Object 



204
205
206
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 204

def [](key)
  to_hash[key]
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



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
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 142

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 = Bitpesa.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



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 216

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

Returns the model itself

Returns:

  • (Object) —

    Returns the model itself



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 121

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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

#dig(*args) ⇒ Object 



208
209
210
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 208

def dig(*args)
  to_hash.dig(*args)
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


106
107
108
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 106

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



112
113
114
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 112

def hash
  [webhook, event, object].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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 68

def list_invalid_properties
  invalid_properties = Array.new
  if @webhook.nil?
    invalid_properties.push('invalid value for "webhook", webhook cannot be nil.')
  end

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

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



188
189
190
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 188

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



194
195
196
197
198
199
200
201
202
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 194

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
  ::ActiveSupport::HashWithIndifferentAccess.new(hash)
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



182
183
184
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 182

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



87
88
89
90
91
92
 
# File 'lib/bitpesa-sdk/models/webhook.rb', line 87

def valid?
  return false if @webhook.nil?
  return false if @event.nil?
  return false if @object.nil?
  true
end