Class: Bitpesa::WebhookLogMetadata

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookLogMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
115
116
117
118
119
120
121
122
123
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 78

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_key_id ⇒ Object

ID of API key in use at point of webhook event



42
43
44
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 42

def api_key_id
  @api_key_id
end

#app_id ⇒ Object

ID of app on which webhook event was triggered



39
40
41
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 39

def app_id
  @app_id
end

#attempt_id ⇒ Object

Attempt ID



29
30
31
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 29

def attempt_id
  @attempt_id
end

#event ⇒ Object

Specific event that triggered the webhook



20
21
22
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 20

def event
  @event
end

#instance_id ⇒ Object

Instance ID of the webhook event



23
24
25
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 23

def instance_id
  @instance_id
end

#instance_type ⇒ Object

Type of instance event



26
27
28
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 26

def instance_type
  @instance_type
end

#params ⇒ Object

Returns the value of attribute params.



17
18
19
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 17

def params
  @params
end

#request ⇒ Object

Returns the value of attribute request.



34
35
36
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 34

def request
  @request
end

#response ⇒ Object

Returns the value of attribute response.



36
37
38
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 36

def response
  @response
end

#tries ⇒ Object

Number of tries at the point webhook was triggered



32
33
34
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 32

def tries
  @tries
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 45

def self.attribute_map
  {
    :'params' => :'params',
    :'event' => :'event',
    :'instance_id' => :'instance_id',
    :'instance_type' => :'instance_type',
    :'attempt_id' => :'attempt_id',
    :'tries' => :'tries',
    :'request' => :'request',
    :'response' => :'response',
    :'app_id' => :'app_id',
    :'api_key_id' => :'api_key_id'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 61

def self.openapi_types
  {
    :'params' => :'WebhookDefinition',
    :'event' => :'String',
    :'instance_id' => :'String',
    :'instance_type' => :'String',
    :'attempt_id' => :'String',
    :'tries' => :'Integer',
    :'request' => :'WebhookLogMetadataRequest',
    :'response' => :'WebhookLogMetadataResponse',
    :'app_id' => :'String',
    :'api_key_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      params == o.params &&
      event == o.event &&
      instance_id == o.instance_id &&
      instance_type == o.instance_type &&
      attempt_id == o.attempt_id &&
      tries == o.tries &&
      request == o.request &&
      response == o.response &&
      app_id == o.app_id &&
      api_key_id == o.api_key_id
end

#[](key) ⇒ Object 



255
256
257
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 255

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 193

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



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 267

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



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

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 



259
260
261
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 259

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


157
158
159
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 163

def hash
  [params, event, instance_id, instance_type, attempt_id, tries, request, response, app_id, api_key_id].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



127
128
129
130
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 127

def list_invalid_properties
  invalid_properties = Array.new
  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



239
240
241
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 239

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



245
246
247
248
249
250
251
252
253
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 245

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



233
234
235
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 233

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



134
135
136
 
# File 'lib/bitpesa-sdk/models/webhook_log_metadata.rb', line 134

def valid?
  true
end