Class: Bitpesa::ApiLog

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

Overview

The response object returned with requests to access individual API logs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiLog

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
115
116
117
118
119
120
121
122
 
# File 'lib/bitpesa-sdk/models/api_log.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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

  if attributes.has_key?(:'request_headers')
    if (value = attributes[:'request_headers']).is_a?(Hash)
      self.request_headers = value
    end
  end

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

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

  if attributes.has_key?(:'response_headers')
    if (value = attributes[:'response_headers']).is_a?(Hash)
      self.response_headers = value
    end
  end

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

Instance Attribute Details

#created_at ⇒ Object

Date and time of response



43
44
45
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 43

def created_at
  @created_at
end

#id ⇒ Object

ID of the API log



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

def id
  @id
end

#request_body ⇒ Object

Body sent with initial request returned as a string



28
29
30
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 28

def request_body
  @request_body
end

#request_headers ⇒ Object

Authorization and access information sent with initial request



31
32
33
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 31

def request_headers
  @request_headers
end

#request_method ⇒ Object

Initial HTTP request method



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

def request_method
  @request_method
end

#request_url ⇒ Object

URL to which initial request was sent



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

def request_url
  @request_url
end

#response_body ⇒ Object

Full response body returned as a string



37
38
39
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 37

def response_body
  @response_body
end

#response_headers ⇒ Object

Headers returned with response



40
41
42
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 40

def response_headers
  @response_headers
end

#response_status ⇒ Object

Status of response



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

def response_status
  @response_status
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'request_method' => :'request_method',
    :'request_url' => :'request_url',
    :'request_body' => :'request_body',
    :'request_headers' => :'request_headers',
    :'response_status' => :'response_status',
    :'response_body' => :'response_body',
    :'response_headers' => :'response_headers',
    :'created_at' => :'created_at'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'request_method' => :'String',
    :'request_url' => :'String',
    :'request_body' => :'String',
    :'request_headers' => :'Hash<String, String>',
    :'response_status' => :'String',
    :'response_body' => :'String',
    :'response_headers' => :'Hash<String, String>',
    :'created_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      request_method == o.request_method &&
      request_url == o.request_url &&
      request_body == o.request_body &&
      request_headers == o.request_headers &&
      response_status == o.response_status &&
      response_body == o.response_body &&
      response_headers == o.response_headers &&
      created_at == o.created_at
end

#[](key) ⇒ Object 



253
254
255
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 253

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



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

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



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

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



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

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 



257
258
259
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 257

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


155
156
157
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



161
162
163
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 161

def hash
  [id, request_method, request_url, request_body, request_headers, response_status, response_body, response_headers, created_at].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



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

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



237
238
239
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 237

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



243
244
245
246
247
248
249
250
251
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 243

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



231
232
233
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 231

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



133
134
135
 
# File 'lib/bitpesa-sdk/models/api_log.rb', line 133

def valid?
  true
end