Class: Bitpesa::Document

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Document

Initializes the object

Parameters:

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

    Model attributes in the form of hash



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/bitpesa-sdk/models/document.rb', line 100

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#category ⇒ Object

uncategorised



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

def category
  @category
end

#errors ⇒ Object

The fields that have some problems and don’t pass validation



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

def errors
  @errors
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#issuing_country ⇒ Object

Issuing country of ID in 2-character alpha ISO 3166-2 country format



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

def issuing_country
  @issuing_country
end

#metadata ⇒ Object

Metadata of document



24
25
26
 
# File 'lib/bitpesa-sdk/models/document.rb', line 24

def metadata
  @metadata
end

#side ⇒ Object

The side of the KYC ID. One of ‘front’ or ‘back’



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

def side
  @side
end

#upload ⇒ Object

Base64 encoded data uri of an image/pdf file or a fully qualified url



18
19
20
 
# File 'lib/bitpesa-sdk/models/document.rb', line 18

def upload
  @upload
end

#upload_content_type ⇒ Object

Returns the value of attribute upload_content_type.



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

def upload_content_type
  @upload_content_type
end

#upload_file_name ⇒ Object

Name of the upload



21
22
23
 
# File 'lib/bitpesa-sdk/models/document.rb', line 21

def upload_file_name
  @upload_file_name
end

#upload_file_size ⇒ Object

Returns the value of attribute upload_file_size.



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

def upload_file_size
  @upload_file_size
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'upload' => :'upload',
    :'upload_file_name' => :'upload_file_name',
    :'metadata' => :'metadata',
    :'upload_content_type' => :'upload_content_type',
    :'upload_file_size' => :'upload_file_size',
    :'category' => :'category',
    :'side' => :'side',
    :'issuing_country' => :'issuing_country',
    :'id' => :'id',
    :'errors' => :'errors'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/bitpesa-sdk/models/document.rb', line 83

def self.openapi_types
  {
    :'upload' => :'String',
    :'upload_file_name' => :'String',
    :'metadata' => :'Object',
    :'upload_content_type' => :'String',
    :'upload_file_size' => :'Integer',
    :'category' => :'String',
    :'side' => :'String',
    :'issuing_country' => :'String',
    :'id' => :'String',
    :'errors' => :'Hash<String, Array<ValidationErrorDescription>>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/bitpesa-sdk/models/document.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      upload == o.upload &&
      upload_file_name == o.upload_file_name &&
      metadata == o.metadata &&
      upload_content_type == o.upload_content_type &&
      upload_file_size == o.upload_file_size &&
      category == o.category &&
      side == o.side &&
      issuing_country == o.issuing_country &&
      id == o.id &&
      errors == o.errors
end

#[](key) ⇒ Object 



301
302
303
 
# File 'lib/bitpesa-sdk/models/document.rb', line 301

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/bitpesa-sdk/models/document.rb', line 239

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/bitpesa-sdk/models/document.rb', line 313

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/bitpesa-sdk/models/document.rb', line 218

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 



305
306
307
 
# File 'lib/bitpesa-sdk/models/document.rb', line 305

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


203
204
205
 
# File 'lib/bitpesa-sdk/models/document.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



209
210
211
 
# File 'lib/bitpesa-sdk/models/document.rb', line 209

def hash
  [upload, upload_file_name, metadata, upload_content_type, upload_file_size, category, side, issuing_country, id, errors].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



151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/bitpesa-sdk/models/document.rb', line 151

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

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



285
286
287
 
# File 'lib/bitpesa-sdk/models/document.rb', line 285

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



291
292
293
294
295
296
297
298
299
 
# File 'lib/bitpesa-sdk/models/document.rb', line 291

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



279
280
281
 
# File 'lib/bitpesa-sdk/models/document.rb', line 279

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



166
167
168
169
170
171
172
 
# File 'lib/bitpesa-sdk/models/document.rb', line 166

def valid?
  return false if @upload.nil?
  return false if @upload_file_name.nil?
  side_validator = EnumAttributeValidator.new('String', ['front', 'back'])
  return false unless side_validator.valid?(@side)
  true
end