onfido 2.9.0 → 3.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (378) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +11 -4
  3. data/Gemfile +5 -4
  4. data/LICENSE +5 -7
  5. data/README.md +69 -51
  6. data/Rakefile +10 -0
  7. data/lib/onfido/api/default_api.rb +4233 -0
  8. data/lib/onfido/api_client.rb +431 -0
  9. data/lib/onfido/api_error.rb +58 -0
  10. data/lib/onfido/configuration.rb +420 -0
  11. data/lib/onfido/models/address.rb +422 -0
  12. data/lib/onfido/models/address_builder.rb +422 -0
  13. data/lib/onfido/models/address_shared.rb +415 -0
  14. data/lib/onfido/models/addresses_list.rb +216 -0
  15. data/lib/onfido/models/applicant.rb +390 -0
  16. data/lib/onfido/models/applicant_builder.rb +358 -0
  17. data/lib/onfido/models/applicant_create.rb +281 -0
  18. data/lib/onfido/models/applicant_request.rb +232 -0
  19. data/lib/onfido/models/applicant_response.rb +341 -0
  20. data/lib/onfido/models/applicant_shared.rb +246 -0
  21. data/lib/onfido/models/applicant_update.rb +267 -0
  22. data/lib/onfido/models/applicant_updater.rb +344 -0
  23. data/lib/onfido/models/applicants_list.rb +223 -0
  24. data/lib/onfido/models/check.rb +419 -0
  25. data/lib/onfido/models/check_builder.rb +360 -0
  26. data/lib/onfido/models/check_request.rb +301 -0
  27. data/lib/onfido/models/check_response.rb +350 -0
  28. data/lib/onfido/models/check_shared.rb +266 -0
  29. data/lib/onfido/models/checks_list.rb +223 -0
  30. data/lib/onfido/models/complete_task_builder.rb +221 -0
  31. data/lib/onfido/models/complete_task_data_builder.rb +106 -0
  32. data/lib/onfido/models/consent_item.rb +272 -0
  33. data/lib/onfido/models/consents_builder.rb +205 -0
  34. data/lib/onfido/models/country_codes.rb +289 -0
  35. data/lib/onfido/models/device_intelligence_breakdown.rb +223 -0
  36. data/lib/onfido/models/device_intelligence_breakdown_breakdown.rb +214 -0
  37. data/lib/onfido/models/device_intelligence_breakdown_breakdown_device.rb +215 -0
  38. data/lib/onfido/models/device_intelligence_breakdown_breakdown_device_breakdown.rb +232 -0
  39. data/lib/onfido/models/device_intelligence_breakdown_properties.rb +232 -0
  40. data/lib/onfido/models/device_intelligence_breakdown_properties_device.rb +468 -0
  41. data/lib/onfido/models/device_intelligence_breakdown_properties_geolocation.rb +257 -0
  42. data/lib/onfido/models/device_intelligence_breakdown_properties_ip.rb +245 -0
  43. data/lib/onfido/models/device_intelligence_report.rb +345 -0
  44. data/lib/onfido/models/document.rb +376 -0
  45. data/lib/onfido/models/document_breakdown.rb +286 -0
  46. data/lib/onfido/models/document_breakdown_age_validation.rb +224 -0
  47. data/lib/onfido/models/document_breakdown_age_validation_breakdown.rb +214 -0
  48. data/lib/onfido/models/document_breakdown_compromised_document.rb +224 -0
  49. data/lib/onfido/models/document_breakdown_compromised_document_breakdown.rb +223 -0
  50. data/lib/onfido/models/document_breakdown_data_comparison.rb +224 -0
  51. data/lib/onfido/models/document_breakdown_data_comparison_breakdown.rb +277 -0
  52. data/lib/onfido/models/document_breakdown_data_comparison_breakdown_issuing_country.rb +223 -0
  53. data/lib/onfido/models/document_breakdown_data_consistency.rb +224 -0
  54. data/lib/onfido/models/document_breakdown_data_consistency_breakdown.rb +295 -0
  55. data/lib/onfido/models/document_breakdown_data_validation.rb +224 -0
  56. data/lib/onfido/models/document_breakdown_data_validation_breakdown.rb +268 -0
  57. data/lib/onfido/models/document_breakdown_data_validation_breakdown_document_expiration.rb +224 -0
  58. data/lib/onfido/models/document_breakdown_data_validation_breakdown_expiry_date.rb +224 -0
  59. data/lib/onfido/models/document_breakdown_image_integrity.rb +224 -0
  60. data/lib/onfido/models/document_breakdown_image_integrity_breakdown.rb +241 -0
  61. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_colour_picture.rb +224 -0
  62. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_conclusive_document_quality.rb +224 -0
  63. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_image_quality.rb +224 -0
  64. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_supported_document.rb +224 -0
  65. data/lib/onfido/models/document_breakdown_issuing_authority.rb +224 -0
  66. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown.rb +223 -0
  67. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_active_authentication.rb +224 -0
  68. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_passive_authentication.rb +224 -0
  69. data/lib/onfido/models/document_breakdown_police_record.rb +215 -0
  70. data/lib/onfido/models/document_breakdown_visual_authenticity.rb +224 -0
  71. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown.rb +277 -0
  72. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_digital_tampering.rb +224 -0
  73. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_face_detection.rb +224 -0
  74. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_fonts.rb +224 -0
  75. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_original_document_present.rb +224 -0
  76. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_other.rb +224 -0
  77. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_picture_face_integrity.rb +224 -0
  78. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_security_features.rb +224 -0
  79. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_template.rb +224 -0
  80. data/lib/onfido/models/document_cdq_reasons.rb +285 -0
  81. data/lib/onfido/models/document_iq_reasons.rb +305 -0
  82. data/lib/onfido/models/document_odp_reasons.rb +245 -0
  83. data/lib/onfido/models/document_properties.rb +663 -0
  84. data/lib/onfido/models/document_properties_address_lines.rb +259 -0
  85. data/lib/onfido/models/document_properties_barcode_inner.rb +367 -0
  86. data/lib/onfido/models/document_properties_document_classification.rb +232 -0
  87. data/lib/onfido/models/document_properties_document_numbers_inner.rb +223 -0
  88. data/lib/onfido/models/document_properties_driving_licence_information.rb +241 -0
  89. data/lib/onfido/models/document_properties_extracted_data.rb +394 -0
  90. data/lib/onfido/models/document_properties_nfc.rb +322 -0
  91. data/lib/onfido/models/document_report.rb +354 -0
  92. data/lib/onfido/models/document_response.rb +272 -0
  93. data/lib/onfido/models/document_shared.rb +301 -0
  94. data/lib/onfido/models/document_types.rb +64 -0
  95. data/lib/onfido/models/document_video_report.rb +354 -0
  96. data/lib/onfido/models/document_video_with_address_information_report.rb +354 -0
  97. data/lib/onfido/models/document_with_address_information_report.rb +354 -0
  98. data/lib/onfido/models/document_with_driver_verification_report.rb +354 -0
  99. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb +731 -0
  100. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle.rb +236 -0
  101. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner.rb +245 -0
  102. data/lib/onfido/models/document_with_driving_licence_information_report.rb +354 -0
  103. data/lib/onfido/models/documents_list.rb +223 -0
  104. data/lib/onfido/models/error.rb +214 -0
  105. data/lib/onfido/models/error1.rb +224 -0
  106. data/lib/onfido/models/error_properties.rb +234 -0
  107. data/lib/onfido/models/error_properties1.rb +223 -0
  108. data/lib/onfido/models/extract_request.rb +222 -0
  109. data/lib/onfido/models/extraction.rb +233 -0
  110. data/lib/onfido/models/extraction_document_classification.rb +289 -0
  111. data/lib/onfido/models/extraction_extracted_data.rb +530 -0
  112. data/lib/onfido/models/facial_similarity_motion_breakdown.rb +232 -0
  113. data/lib/onfido/models/facial_similarity_motion_breakdown_face_comparison.rb +224 -0
  114. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity.rb +224 -0
  115. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown.rb +223 -0
  116. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_face_detected.rb +224 -0
  117. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_source_integrity.rb +224 -0
  118. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity.rb +224 -0
  119. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown.rb +223 -0
  120. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +224 -0
  121. data/lib/onfido/models/facial_similarity_motion_properties.rb +215 -0
  122. data/lib/onfido/models/facial_similarity_motion_report.rb +354 -0
  123. data/lib/onfido/models/facial_similarity_photo_breakdown.rb +232 -0
  124. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison.rb +224 -0
  125. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown.rb +214 -0
  126. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match.rb +224 -0
  127. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match_properties.rb +225 -0
  128. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity.rb +224 -0
  129. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown.rb +223 -0
  130. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_face_detected.rb +224 -0
  131. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_source_integrity.rb +224 -0
  132. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity.rb +224 -0
  133. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown.rb +214 -0
  134. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +224 -0
  135. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection_properties.rb +215 -0
  136. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown.rb +232 -0
  137. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity.rb +224 -0
  138. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown.rb +223 -0
  139. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity.rb +224 -0
  140. data/lib/onfido/models/facial_similarity_photo_fully_auto_properties.rb +215 -0
  141. data/lib/onfido/models/facial_similarity_photo_fully_auto_report.rb +354 -0
  142. data/lib/onfido/models/facial_similarity_photo_properties.rb +215 -0
  143. data/lib/onfido/models/facial_similarity_photo_report.rb +354 -0
  144. data/lib/onfido/models/facial_similarity_video_breakdown.rb +232 -0
  145. data/lib/onfido/models/facial_similarity_video_breakdown_face_comparison.rb +224 -0
  146. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity.rb +224 -0
  147. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown.rb +223 -0
  148. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected.rb +224 -0
  149. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity.rb +224 -0
  150. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity.rb +224 -0
  151. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown.rb +223 -0
  152. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected.rb +224 -0
  153. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +224 -0
  154. data/lib/onfido/models/facial_similarity_video_properties.rb +215 -0
  155. data/lib/onfido/models/facial_similarity_video_report.rb +354 -0
  156. data/lib/onfido/models/id_number.rb +269 -0
  157. data/lib/onfido/models/id_photo.rb +289 -0
  158. data/lib/onfido/models/id_photo_response.rb +282 -0
  159. data/lib/onfido/models/id_photos_list.rb +223 -0
  160. data/lib/onfido/models/identity_enhanced_breakdown.rb +241 -0
  161. data/lib/onfido/models/identity_enhanced_breakdown_address.rb +224 -0
  162. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown.rb +232 -0
  163. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies.rb +224 -0
  164. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies_properties.rb +214 -0
  165. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_telephone_database.rb +224 -0
  166. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_voting_register.rb +224 -0
  167. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth.rb +224 -0
  168. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown.rb +223 -0
  169. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies.rb +224 -0
  170. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_voting_register.rb +224 -0
  171. data/lib/onfido/models/identity_enhanced_breakdown_mortality.rb +215 -0
  172. data/lib/onfido/models/identity_enhanced_breakdown_sources.rb +224 -0
  173. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown.rb +214 -0
  174. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources.rb +224 -0
  175. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources_properties.rb +214 -0
  176. data/lib/onfido/models/identity_enhanced_properties.rb +227 -0
  177. data/lib/onfido/models/identity_enhanced_properties_matched_addresses_inner.rb +227 -0
  178. data/lib/onfido/models/identity_enhanced_report.rb +354 -0
  179. data/lib/onfido/models/india_pan_report.rb +354 -0
  180. data/lib/onfido/models/india_pan_report_all_of_breakdown.rb +214 -0
  181. data/lib/onfido/models/india_pan_report_all_of_breakdown_device.rb +214 -0
  182. data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown.rb +223 -0
  183. data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown_pan_valid.rb +214 -0
  184. data/lib/onfido/models/india_pan_report_all_of_properties.rb +214 -0
  185. data/lib/onfido/models/india_pan_report_all_of_properties_device.rb +225 -0
  186. data/lib/onfido/models/known_faces_breakdown.rb +223 -0
  187. data/lib/onfido/models/known_faces_breakdown_image_integrity.rb +215 -0
  188. data/lib/onfido/models/known_faces_breakdown_previously_seen_faces.rb +215 -0
  189. data/lib/onfido/models/known_faces_properties.rb +217 -0
  190. data/lib/onfido/models/known_faces_properties_matches_inner.rb +255 -0
  191. data/lib/onfido/models/known_faces_report.rb +354 -0
  192. data/lib/onfido/models/live_photo.rb +289 -0
  193. data/lib/onfido/models/live_photo_response.rb +282 -0
  194. data/lib/onfido/models/live_photos_list.rb +223 -0
  195. data/lib/onfido/models/live_video.rb +287 -0
  196. data/lib/onfido/models/live_videos_list.rb +223 -0
  197. data/lib/onfido/models/location.rb +254 -0
  198. data/lib/onfido/models/location_builder.rb +254 -0
  199. data/lib/onfido/models/location_shared.rb +247 -0
  200. data/lib/onfido/models/motion_capture.rb +275 -0
  201. data/lib/onfido/models/motion_captures_list.rb +223 -0
  202. data/lib/onfido/models/photo_auto_reasons.rb +255 -0
  203. data/lib/onfido/models/photo_reasons.rb +255 -0
  204. data/lib/onfido/models/proof_of_address_breakdown.rb +232 -0
  205. data/lib/onfido/models/proof_of_address_breakdown_data_comparison.rb +224 -0
  206. data/lib/onfido/models/proof_of_address_breakdown_data_comparison_breakdown.rb +232 -0
  207. data/lib/onfido/models/proof_of_address_breakdown_document_classification.rb +224 -0
  208. data/lib/onfido/models/proof_of_address_breakdown_document_classification_breakdown.rb +214 -0
  209. data/lib/onfido/models/proof_of_address_breakdown_image_integrity.rb +224 -0
  210. data/lib/onfido/models/proof_of_address_breakdown_image_integrity_breakdown.rb +214 -0
  211. data/lib/onfido/models/proof_of_address_properties.rb +319 -0
  212. data/lib/onfido/models/proof_of_address_report.rb +354 -0
  213. data/lib/onfido/models/repeat_attempts_list.rb +292 -0
  214. data/lib/onfido/models/repeat_attempts_list_repeat_attempts_inner.rb +333 -0
  215. data/lib/onfido/models/report.rb +93 -0
  216. data/lib/onfido/models/report_document.rb +222 -0
  217. data/lib/onfido/models/report_name.rb +60 -0
  218. data/lib/onfido/models/report_result.rb +42 -0
  219. data/lib/onfido/models/report_shared.rb +329 -0
  220. data/lib/onfido/models/report_status.rb +44 -0
  221. data/lib/onfido/models/report_sub_result.rb +43 -0
  222. data/lib/onfido/models/reports_list.rb +223 -0
  223. data/lib/onfido/models/results_feedback.rb +279 -0
  224. data/lib/onfido/models/sdk_token.rb +229 -0
  225. data/lib/onfido/models/sdk_token_builder.rb +259 -0
  226. data/lib/onfido/models/sdk_token_request.rb +252 -0
  227. data/lib/onfido/models/sdk_token_response.rb +222 -0
  228. data/lib/onfido/models/task.rb +329 -0
  229. data/lib/onfido/models/task_item.rb +287 -0
  230. data/lib/onfido/models/timeline_file_reference.rb +239 -0
  231. data/lib/onfido/models/us_driving_licence_breakdown.rb +232 -0
  232. data/lib/onfido/models/us_driving_licence_breakdown_address.rb +224 -0
  233. data/lib/onfido/models/us_driving_licence_breakdown_address_breakdown.rb +259 -0
  234. data/lib/onfido/models/us_driving_licence_breakdown_document.rb +224 -0
  235. data/lib/onfido/models/us_driving_licence_breakdown_document_breakdown.rb +241 -0
  236. data/lib/onfido/models/us_driving_licence_breakdown_personal.rb +224 -0
  237. data/lib/onfido/models/us_driving_licence_breakdown_personal_breakdown.rb +322 -0
  238. data/lib/onfido/models/us_driving_licence_builder.rb +505 -0
  239. data/lib/onfido/models/us_driving_licence_report.rb +354 -0
  240. data/lib/onfido/models/us_driving_licence_shared.rb +499 -0
  241. data/lib/onfido/models/video_reasons.rb +245 -0
  242. data/lib/onfido/models/watchlist_aml_breakdown.rb +241 -0
  243. data/lib/onfido/models/watchlist_aml_breakdown_adverse_media.rb +215 -0
  244. data/lib/onfido/models/watchlist_aml_breakdown_legal_and_regulatory_warnings.rb +215 -0
  245. data/lib/onfido/models/watchlist_aml_breakdown_politically_exposed_person.rb +215 -0
  246. data/lib/onfido/models/watchlist_aml_breakdown_sanction.rb +215 -0
  247. data/lib/onfido/models/watchlist_aml_properties.rb +217 -0
  248. data/lib/onfido/models/watchlist_aml_report.rb +354 -0
  249. data/lib/onfido/models/watchlist_enhanced_breakdown.rb +241 -0
  250. data/lib/onfido/models/watchlist_enhanced_properties.rb +217 -0
  251. data/lib/onfido/models/watchlist_enhanced_report.rb +354 -0
  252. data/lib/onfido/models/watchlist_monitor.rb +342 -0
  253. data/lib/onfido/models/watchlist_monitor_builder.rb +292 -0
  254. data/lib/onfido/models/watchlist_monitor_match.rb +225 -0
  255. data/lib/onfido/models/watchlist_monitor_matches_list.rb +223 -0
  256. data/lib/onfido/models/watchlist_monitor_matches_updater.rb +227 -0
  257. data/lib/onfido/models/watchlist_monitor_response.rb +254 -0
  258. data/lib/onfido/models/watchlist_monitor_shared.rb +285 -0
  259. data/lib/onfido/models/watchlist_monitors_list.rb +223 -0
  260. data/lib/onfido/models/watchlist_peps_only_report.rb +354 -0
  261. data/lib/onfido/models/watchlist_sanctions_only_report.rb +354 -0
  262. data/lib/onfido/models/watchlist_standard_breakdown.rb +232 -0
  263. data/lib/onfido/models/watchlist_standard_properties.rb +217 -0
  264. data/lib/onfido/models/watchlist_standard_report.rb +354 -0
  265. data/lib/onfido/models/webhook.rb +304 -0
  266. data/lib/onfido/models/webhook_builder.rb +274 -0
  267. data/lib/onfido/models/webhook_create.rb +222 -0
  268. data/lib/onfido/models/webhook_event.rb +214 -0
  269. data/lib/onfido/models/webhook_event_payload.rb +273 -0
  270. data/lib/onfido/models/webhook_event_payload_object.rb +260 -0
  271. data/lib/onfido/models/webhook_event_type.rb +56 -0
  272. data/lib/onfido/models/webhook_resend.rb +216 -0
  273. data/lib/onfido/models/webhook_response.rb +252 -0
  274. data/lib/onfido/models/webhook_shared.rb +249 -0
  275. data/lib/onfido/models/webhook_update.rb +215 -0
  276. data/lib/onfido/models/webhook_updater.rb +267 -0
  277. data/lib/onfido/models/webhooks_list.rb +223 -0
  278. data/lib/onfido/models/webhooks_resend_item.rb +261 -0
  279. data/lib/onfido/models/workflow_run.rb +416 -0
  280. data/lib/onfido/models/workflow_run_builder.rb +316 -0
  281. data/lib/onfido/models/workflow_run_request.rb +217 -0
  282. data/lib/onfido/models/workflow_run_response.rb +317 -0
  283. data/lib/onfido/models/workflow_run_response_error.rb +226 -0
  284. data/lib/onfido/models/workflow_run_shared.rb +296 -0
  285. data/lib/onfido/models/workflow_run_shared_link.rb +290 -0
  286. data/lib/onfido/version.rb +12 -2
  287. data/lib/onfido/webhook_event_verifier.rb +20 -0
  288. data/lib/onfido.rb +309 -25
  289. data/onfido.gemspec +42 -33
  290. data/spec/integrations/address_picker_spec.rb +16 -0
  291. data/spec/integrations/applicant_spec.rb +73 -95
  292. data/spec/integrations/check_spec.rb +60 -41
  293. data/spec/integrations/document_spec.rb +28 -57
  294. data/spec/integrations/extraction_spec.rb +27 -12
  295. data/spec/integrations/id_photo_spec.rb +55 -0
  296. data/spec/integrations/live_photo_spec.rb +28 -45
  297. data/spec/integrations/live_video_spec.rb +33 -19
  298. data/spec/integrations/media/sample_driving_licence.png +0 -0
  299. data/spec/integrations/media/sample_photo.png +0 -0
  300. data/spec/integrations/motion_capture_spec.rb +30 -24
  301. data/spec/integrations/report_schema_spec.rb +45 -0
  302. data/spec/integrations/report_spec.rb +34 -25
  303. data/spec/integrations/sdk_token_spec.rb +12 -10
  304. data/spec/integrations/tasks_spec.rb +45 -0
  305. data/spec/integrations/watchlist_monitor_spec.rb +73 -0
  306. data/spec/integrations/webhook_spec.rb +40 -88
  307. data/spec/integrations/workflow_run_output_spec.rb +117 -0
  308. data/spec/integrations/workflow_run_spec.rb +64 -34
  309. data/spec/shared_contexts/with_applicant.rb +24 -0
  310. data/spec/shared_contexts/with_check.rb +18 -0
  311. data/spec/shared_contexts/with_document.rb +13 -0
  312. data/spec/shared_contexts/with_live_photo.rb +18 -0
  313. data/spec/shared_contexts/with_onfido.rb +14 -0
  314. data/spec/shared_contexts/with_workflow_run.rb +19 -0
  315. data/spec/spec_helper.rb +73 -11
  316. data/spec/webhook_event_verifier_spec.rb +29 -0
  317. metadata +367 -157
  318. data/.github/workflows/gem-push.yml +0 -31
  319. data/.github/workflows/ruby.yml +0 -25
  320. data/.gitignore +0 -19
  321. data/.rspec +0 -2
  322. data/.rubocop.yml +0 -13
  323. data/lib/onfido/api.rb +0 -65
  324. data/lib/onfido/errors/connection_error.rb +0 -6
  325. data/lib/onfido/errors/onfido_error.rb +0 -30
  326. data/lib/onfido/errors/request_error.rb +0 -6
  327. data/lib/onfido/errors/server_error.rb +0 -6
  328. data/lib/onfido/options.rb +0 -38
  329. data/lib/onfido/resource.rb +0 -153
  330. data/lib/onfido/resources/address.rb +0 -9
  331. data/lib/onfido/resources/applicant.rb +0 -29
  332. data/lib/onfido/resources/check.rb +0 -28
  333. data/lib/onfido/resources/document.rb +0 -28
  334. data/lib/onfido/resources/extraction.rb +0 -11
  335. data/lib/onfido/resources/live_photo.rb +0 -27
  336. data/lib/onfido/resources/live_video.rb +0 -17
  337. data/lib/onfido/resources/monitor.rb +0 -32
  338. data/lib/onfido/resources/motion_capture.rb +0 -21
  339. data/lib/onfido/resources/report.rb +0 -21
  340. data/lib/onfido/resources/sdk_token.rb +0 -10
  341. data/lib/onfido/resources/webhook.rb +0 -40
  342. data/lib/onfido/resources/workflow_run.rb +0 -21
  343. data/spec/integrations/address_spec.rb +0 -13
  344. data/spec/integrations/monitor_spec.rb +0 -100
  345. data/spec/integrations/resource_spec.rb +0 -106
  346. data/spec/onfido/api_spec.rb +0 -22
  347. data/spec/onfido/connection_error_spec.rb +0 -20
  348. data/spec/onfido/options_spec.rb +0 -39
  349. data/spec/onfido/request_error_spec.rb +0 -36
  350. data/spec/support/fake_onfido_api.rb +0 -295
  351. data/spec/support/fixtures/4xx_response.json +0 -14
  352. data/spec/support/fixtures/addresses.json +0 -24
  353. data/spec/support/fixtures/applicant.json +0 -28
  354. data/spec/support/fixtures/applicants.json +0 -12
  355. data/spec/support/fixtures/check.json +0 -12
  356. data/spec/support/fixtures/checks.json +0 -16
  357. data/spec/support/fixtures/document.json +0 -10
  358. data/spec/support/fixtures/documents.json +0 -23
  359. data/spec/support/fixtures/extraction.json +0 -23
  360. data/spec/support/fixtures/live_photo.json +0 -9
  361. data/spec/support/fixtures/live_photos.json +0 -22
  362. data/spec/support/fixtures/live_video.json +0 -23
  363. data/spec/support/fixtures/live_videos.json +0 -27
  364. data/spec/support/fixtures/monitor.json +0 -8
  365. data/spec/support/fixtures/monitor_matches.json +0 -12
  366. data/spec/support/fixtures/monitors.json +0 -12
  367. data/spec/support/fixtures/motion_capture.json +0 -9
  368. data/spec/support/fixtures/motion_captures.json +0 -13
  369. data/spec/support/fixtures/not_scheduled_for_deletion_error.json +0 -7
  370. data/spec/support/fixtures/report.json +0 -10
  371. data/spec/support/fixtures/reports.json +0 -24
  372. data/spec/support/fixtures/sdk_token.json +0 -3
  373. data/spec/support/fixtures/signed_workflow_run.pdf +0 -0
  374. data/spec/support/fixtures/unexpected_error_format.json +0 -3
  375. data/spec/support/fixtures/webhook.json +0 -14
  376. data/spec/support/fixtures/webhooks.json +0 -31
  377. data/spec/support/fixtures/workflow_run.json +0 -20
  378. data/spec/support/fixtures/workflow_runs.json +0 -42
@@ -0,0 +1,731 @@
1
+ =begin
2
+ #Onfido API v3.6
3
+
4
+ #The Onfido API (v3.6)
5
+
6
+ The version of the OpenAPI document: v3.6
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.6.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Onfido
17
+ class DocumentWithDriverVerificationReportAllOfProperties
18
+ attr_accessor :date_of_birth
19
+
20
+ attr_accessor :date_of_expiry
21
+
22
+ attr_accessor :personal_number
23
+
24
+ attr_accessor :document_numbers
25
+
26
+ attr_accessor :document_type
27
+
28
+ attr_accessor :first_name
29
+
30
+ attr_accessor :gender
31
+
32
+ attr_accessor :issuing_country
33
+
34
+ attr_accessor :last_name
35
+
36
+ attr_accessor :nationality
37
+
38
+ attr_accessor :issuing_state
39
+
40
+ attr_accessor :issuing_date
41
+
42
+ attr_accessor :categorisation
43
+
44
+ attr_accessor :mrz_line1
45
+
46
+ attr_accessor :mrz_line2
47
+
48
+ attr_accessor :mrz_line3
49
+
50
+ attr_accessor :address
51
+
52
+ attr_accessor :place_of_birth
53
+
54
+ attr_accessor :spouse_name
55
+
56
+ attr_accessor :widow_name
57
+
58
+ attr_accessor :alias_name
59
+
60
+ attr_accessor :issuing_authority
61
+
62
+ attr_accessor :remarks
63
+
64
+ attr_accessor :civil_state
65
+
66
+ attr_accessor :expatriation
67
+
68
+ attr_accessor :father_name
69
+
70
+ attr_accessor :mother_name
71
+
72
+ attr_accessor :religion
73
+
74
+ attr_accessor :type_of_permit
75
+
76
+ attr_accessor :version_number
77
+
78
+ attr_accessor :document_subtype
79
+
80
+ attr_accessor :profession
81
+
82
+ attr_accessor :security_document_number
83
+
84
+ attr_accessor :tax_number
85
+
86
+ attr_accessor :nist_identity_evidence_strength
87
+
88
+ attr_accessor :has_issuance_confirmation
89
+
90
+ attr_accessor :real_id_compliance
91
+
92
+ attr_accessor :security_tier
93
+
94
+ attr_accessor :address_lines
95
+
96
+ attr_accessor :barcode
97
+
98
+ attr_accessor :nfc
99
+
100
+ attr_accessor :driving_licence_information
101
+
102
+ attr_accessor :document_classification
103
+
104
+ attr_accessor :extracted_data
105
+
106
+ # True for **non-restricted** driving licences
107
+ attr_accessor :drivers_licence
108
+
109
+ # True for **limited/restricted** driving license, including learner's permits
110
+ attr_accessor :restricted_licence
111
+
112
+ # Underlying, non-normalised, licence category (e.g. \"Junior operators license\")
113
+ attr_accessor :raw_licence_category
114
+
115
+ # Comma-separated vehicle classes that the user is qualified for
116
+ attr_accessor :raw_vehicle_classes
117
+
118
+ # Detailed classes/categories information
119
+ attr_accessor :vehicle_class_details
120
+
121
+ attr_accessor :passenger_vehicle
122
+
123
+ class EnumAttributeValidator
124
+ attr_reader :datatype
125
+ attr_reader :allowable_values
126
+
127
+ def initialize(datatype, allowable_values)
128
+ @allowable_values = allowable_values.map do |value|
129
+ case datatype.to_s
130
+ when /Integer/i
131
+ value.to_i
132
+ when /Float/i
133
+ value.to_f
134
+ else
135
+ value
136
+ end
137
+ end
138
+ end
139
+
140
+ def valid?(value)
141
+ !value || allowable_values.include?(value)
142
+ end
143
+ end
144
+
145
+ # Attribute mapping from ruby-style variable name to JSON key.
146
+ def self.attribute_map
147
+ {
148
+ :'date_of_birth' => :'date_of_birth',
149
+ :'date_of_expiry' => :'date_of_expiry',
150
+ :'personal_number' => :'personal_number',
151
+ :'document_numbers' => :'document_numbers',
152
+ :'document_type' => :'document_type',
153
+ :'first_name' => :'first_name',
154
+ :'gender' => :'gender',
155
+ :'issuing_country' => :'issuing_country',
156
+ :'last_name' => :'last_name',
157
+ :'nationality' => :'nationality',
158
+ :'issuing_state' => :'issuing_state',
159
+ :'issuing_date' => :'issuing_date',
160
+ :'categorisation' => :'categorisation',
161
+ :'mrz_line1' => :'mrz_line1',
162
+ :'mrz_line2' => :'mrz_line2',
163
+ :'mrz_line3' => :'mrz_line3',
164
+ :'address' => :'address',
165
+ :'place_of_birth' => :'place_of_birth',
166
+ :'spouse_name' => :'spouse_name',
167
+ :'widow_name' => :'widow_name',
168
+ :'alias_name' => :'alias_name',
169
+ :'issuing_authority' => :'issuing_authority',
170
+ :'remarks' => :'remarks',
171
+ :'civil_state' => :'civil_state',
172
+ :'expatriation' => :'expatriation',
173
+ :'father_name' => :'father_name',
174
+ :'mother_name' => :'mother_name',
175
+ :'religion' => :'religion',
176
+ :'type_of_permit' => :'type_of_permit',
177
+ :'version_number' => :'version_number',
178
+ :'document_subtype' => :'document_subtype',
179
+ :'profession' => :'profession',
180
+ :'security_document_number' => :'security_document_number',
181
+ :'tax_number' => :'tax_number',
182
+ :'nist_identity_evidence_strength' => :'nist_identity_evidence_strength',
183
+ :'has_issuance_confirmation' => :'has_issuance_confirmation',
184
+ :'real_id_compliance' => :'real_id_compliance',
185
+ :'security_tier' => :'security_tier',
186
+ :'address_lines' => :'address_lines',
187
+ :'barcode' => :'barcode',
188
+ :'nfc' => :'nfc',
189
+ :'driving_licence_information' => :'driving_licence_information',
190
+ :'document_classification' => :'document_classification',
191
+ :'extracted_data' => :'extracted_data',
192
+ :'drivers_licence' => :'drivers_licence',
193
+ :'restricted_licence' => :'restricted_licence',
194
+ :'raw_licence_category' => :'raw_licence_category',
195
+ :'raw_vehicle_classes' => :'raw_vehicle_classes',
196
+ :'vehicle_class_details' => :'vehicle_class_details',
197
+ :'passenger_vehicle' => :'passenger_vehicle'
198
+ }
199
+ end
200
+
201
+ # Returns all the JSON keys this model knows about
202
+ def self.acceptable_attributes
203
+ attribute_map.values
204
+ end
205
+
206
+ # Attribute type mapping.
207
+ def self.openapi_types
208
+ {
209
+ :'date_of_birth' => :'Date',
210
+ :'date_of_expiry' => :'Date',
211
+ :'personal_number' => :'String',
212
+ :'document_numbers' => :'Array<DocumentPropertiesDocumentNumbersInner>',
213
+ :'document_type' => :'String',
214
+ :'first_name' => :'String',
215
+ :'gender' => :'String',
216
+ :'issuing_country' => :'String',
217
+ :'last_name' => :'String',
218
+ :'nationality' => :'String',
219
+ :'issuing_state' => :'String',
220
+ :'issuing_date' => :'Date',
221
+ :'categorisation' => :'String',
222
+ :'mrz_line1' => :'String',
223
+ :'mrz_line2' => :'String',
224
+ :'mrz_line3' => :'String',
225
+ :'address' => :'String',
226
+ :'place_of_birth' => :'String',
227
+ :'spouse_name' => :'String',
228
+ :'widow_name' => :'String',
229
+ :'alias_name' => :'String',
230
+ :'issuing_authority' => :'String',
231
+ :'remarks' => :'String',
232
+ :'civil_state' => :'String',
233
+ :'expatriation' => :'String',
234
+ :'father_name' => :'String',
235
+ :'mother_name' => :'String',
236
+ :'religion' => :'String',
237
+ :'type_of_permit' => :'String',
238
+ :'version_number' => :'String',
239
+ :'document_subtype' => :'String',
240
+ :'profession' => :'String',
241
+ :'security_document_number' => :'String',
242
+ :'tax_number' => :'String',
243
+ :'nist_identity_evidence_strength' => :'String',
244
+ :'has_issuance_confirmation' => :'String',
245
+ :'real_id_compliance' => :'Boolean',
246
+ :'security_tier' => :'String',
247
+ :'address_lines' => :'DocumentPropertiesAddressLines',
248
+ :'barcode' => :'Array<DocumentPropertiesBarcodeInner>',
249
+ :'nfc' => :'DocumentPropertiesNfc',
250
+ :'driving_licence_information' => :'DocumentPropertiesDrivingLicenceInformation',
251
+ :'document_classification' => :'DocumentPropertiesDocumentClassification',
252
+ :'extracted_data' => :'DocumentPropertiesExtractedData',
253
+ :'drivers_licence' => :'Boolean',
254
+ :'restricted_licence' => :'Boolean',
255
+ :'raw_licence_category' => :'String',
256
+ :'raw_vehicle_classes' => :'String',
257
+ :'vehicle_class_details' => :'Array<DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner>',
258
+ :'passenger_vehicle' => :'DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle'
259
+ }
260
+ end
261
+
262
+ # List of attributes with nullable: true
263
+ def self.openapi_nullable
264
+ Set.new([
265
+ ])
266
+ end
267
+
268
+ # List of class defined in allOf (OpenAPI v3)
269
+ def self.openapi_all_of
270
+ [
271
+ :'DocumentProperties'
272
+ ]
273
+ end
274
+
275
+ # Initializes the object
276
+ # @param [Hash] attributes Model attributes in the form of hash
277
+ def initialize(attributes = {})
278
+ if (!attributes.is_a?(Hash))
279
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::DocumentWithDriverVerificationReportAllOfProperties` initialize method"
280
+ end
281
+
282
+ # check to see if the attribute exists and convert string to symbol for hash key
283
+ attributes = attributes.each_with_object({}) { |(k, v), h|
284
+ if (!self.class.attribute_map.key?(k.to_sym))
285
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::DocumentWithDriverVerificationReportAllOfProperties`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
286
+ end
287
+ h[k.to_sym] = v
288
+ }
289
+
290
+ if attributes.key?(:'date_of_birth')
291
+ self.date_of_birth = attributes[:'date_of_birth']
292
+ end
293
+
294
+ if attributes.key?(:'date_of_expiry')
295
+ self.date_of_expiry = attributes[:'date_of_expiry']
296
+ end
297
+
298
+ if attributes.key?(:'personal_number')
299
+ self.personal_number = attributes[:'personal_number']
300
+ end
301
+
302
+ if attributes.key?(:'document_numbers')
303
+ if (value = attributes[:'document_numbers']).is_a?(Array)
304
+ self.document_numbers = value
305
+ end
306
+ end
307
+
308
+ if attributes.key?(:'document_type')
309
+ self.document_type = attributes[:'document_type']
310
+ end
311
+
312
+ if attributes.key?(:'first_name')
313
+ self.first_name = attributes[:'first_name']
314
+ end
315
+
316
+ if attributes.key?(:'gender')
317
+ self.gender = attributes[:'gender']
318
+ end
319
+
320
+ if attributes.key?(:'issuing_country')
321
+ self.issuing_country = attributes[:'issuing_country']
322
+ end
323
+
324
+ if attributes.key?(:'last_name')
325
+ self.last_name = attributes[:'last_name']
326
+ end
327
+
328
+ if attributes.key?(:'nationality')
329
+ self.nationality = attributes[:'nationality']
330
+ end
331
+
332
+ if attributes.key?(:'issuing_state')
333
+ self.issuing_state = attributes[:'issuing_state']
334
+ end
335
+
336
+ if attributes.key?(:'issuing_date')
337
+ self.issuing_date = attributes[:'issuing_date']
338
+ end
339
+
340
+ if attributes.key?(:'categorisation')
341
+ self.categorisation = attributes[:'categorisation']
342
+ end
343
+
344
+ if attributes.key?(:'mrz_line1')
345
+ self.mrz_line1 = attributes[:'mrz_line1']
346
+ end
347
+
348
+ if attributes.key?(:'mrz_line2')
349
+ self.mrz_line2 = attributes[:'mrz_line2']
350
+ end
351
+
352
+ if attributes.key?(:'mrz_line3')
353
+ self.mrz_line3 = attributes[:'mrz_line3']
354
+ end
355
+
356
+ if attributes.key?(:'address')
357
+ self.address = attributes[:'address']
358
+ end
359
+
360
+ if attributes.key?(:'place_of_birth')
361
+ self.place_of_birth = attributes[:'place_of_birth']
362
+ end
363
+
364
+ if attributes.key?(:'spouse_name')
365
+ self.spouse_name = attributes[:'spouse_name']
366
+ end
367
+
368
+ if attributes.key?(:'widow_name')
369
+ self.widow_name = attributes[:'widow_name']
370
+ end
371
+
372
+ if attributes.key?(:'alias_name')
373
+ self.alias_name = attributes[:'alias_name']
374
+ end
375
+
376
+ if attributes.key?(:'issuing_authority')
377
+ self.issuing_authority = attributes[:'issuing_authority']
378
+ end
379
+
380
+ if attributes.key?(:'remarks')
381
+ self.remarks = attributes[:'remarks']
382
+ end
383
+
384
+ if attributes.key?(:'civil_state')
385
+ self.civil_state = attributes[:'civil_state']
386
+ end
387
+
388
+ if attributes.key?(:'expatriation')
389
+ self.expatriation = attributes[:'expatriation']
390
+ end
391
+
392
+ if attributes.key?(:'father_name')
393
+ self.father_name = attributes[:'father_name']
394
+ end
395
+
396
+ if attributes.key?(:'mother_name')
397
+ self.mother_name = attributes[:'mother_name']
398
+ end
399
+
400
+ if attributes.key?(:'religion')
401
+ self.religion = attributes[:'religion']
402
+ end
403
+
404
+ if attributes.key?(:'type_of_permit')
405
+ self.type_of_permit = attributes[:'type_of_permit']
406
+ end
407
+
408
+ if attributes.key?(:'version_number')
409
+ self.version_number = attributes[:'version_number']
410
+ end
411
+
412
+ if attributes.key?(:'document_subtype')
413
+ self.document_subtype = attributes[:'document_subtype']
414
+ end
415
+
416
+ if attributes.key?(:'profession')
417
+ self.profession = attributes[:'profession']
418
+ end
419
+
420
+ if attributes.key?(:'security_document_number')
421
+ self.security_document_number = attributes[:'security_document_number']
422
+ end
423
+
424
+ if attributes.key?(:'tax_number')
425
+ self.tax_number = attributes[:'tax_number']
426
+ end
427
+
428
+ if attributes.key?(:'nist_identity_evidence_strength')
429
+ self.nist_identity_evidence_strength = attributes[:'nist_identity_evidence_strength']
430
+ end
431
+
432
+ if attributes.key?(:'has_issuance_confirmation')
433
+ self.has_issuance_confirmation = attributes[:'has_issuance_confirmation']
434
+ end
435
+
436
+ if attributes.key?(:'real_id_compliance')
437
+ self.real_id_compliance = attributes[:'real_id_compliance']
438
+ end
439
+
440
+ if attributes.key?(:'security_tier')
441
+ self.security_tier = attributes[:'security_tier']
442
+ end
443
+
444
+ if attributes.key?(:'address_lines')
445
+ self.address_lines = attributes[:'address_lines']
446
+ end
447
+
448
+ if attributes.key?(:'barcode')
449
+ if (value = attributes[:'barcode']).is_a?(Array)
450
+ self.barcode = value
451
+ end
452
+ end
453
+
454
+ if attributes.key?(:'nfc')
455
+ self.nfc = attributes[:'nfc']
456
+ end
457
+
458
+ if attributes.key?(:'driving_licence_information')
459
+ self.driving_licence_information = attributes[:'driving_licence_information']
460
+ end
461
+
462
+ if attributes.key?(:'document_classification')
463
+ self.document_classification = attributes[:'document_classification']
464
+ end
465
+
466
+ if attributes.key?(:'extracted_data')
467
+ self.extracted_data = attributes[:'extracted_data']
468
+ end
469
+
470
+ if attributes.key?(:'drivers_licence')
471
+ self.drivers_licence = attributes[:'drivers_licence']
472
+ end
473
+
474
+ if attributes.key?(:'restricted_licence')
475
+ self.restricted_licence = attributes[:'restricted_licence']
476
+ end
477
+
478
+ if attributes.key?(:'raw_licence_category')
479
+ self.raw_licence_category = attributes[:'raw_licence_category']
480
+ end
481
+
482
+ if attributes.key?(:'raw_vehicle_classes')
483
+ self.raw_vehicle_classes = attributes[:'raw_vehicle_classes']
484
+ end
485
+
486
+ if attributes.key?(:'vehicle_class_details')
487
+ if (value = attributes[:'vehicle_class_details']).is_a?(Array)
488
+ self.vehicle_class_details = value
489
+ end
490
+ end
491
+
492
+ if attributes.key?(:'passenger_vehicle')
493
+ self.passenger_vehicle = attributes[:'passenger_vehicle']
494
+ end
495
+ end
496
+
497
+ # Show invalid properties with the reasons. Usually used together with valid?
498
+ # @return Array for valid properties with the reasons
499
+ def list_invalid_properties
500
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
501
+ invalid_properties = Array.new
502
+ invalid_properties
503
+ end
504
+
505
+ # Check to see if the all the properties in the model are valid
506
+ # @return true if the model is valid
507
+ def valid?
508
+ warn '[DEPRECATED] the `valid?` method is obsolete'
509
+ nist_identity_evidence_strength_validator = EnumAttributeValidator.new('String', ["superior", "strong", "fair", "weak", "unacceptable", "unspecified_identity_evidence_strength", "unknown_default_open_api"])
510
+ return false unless nist_identity_evidence_strength_validator.valid?(@nist_identity_evidence_strength)
511
+ has_issuance_confirmation_validator = EnumAttributeValidator.new('String', ["true", "false", "unspecified", "unknown_default_open_api"])
512
+ return false unless has_issuance_confirmation_validator.valid?(@has_issuance_confirmation)
513
+ security_tier_validator = EnumAttributeValidator.new('String', ["tier_1", "tier_2", "tier_3", "tier_4", "tier_5", "unspecified_security_tier", "unknown_default_open_api"])
514
+ return false unless security_tier_validator.valid?(@security_tier)
515
+ true
516
+ end
517
+
518
+ # Custom attribute writer method checking allowed values (enum).
519
+ # @param [Object] nist_identity_evidence_strength Object to be assigned
520
+ def nist_identity_evidence_strength=(nist_identity_evidence_strength)
521
+ validator = EnumAttributeValidator.new('String', ["superior", "strong", "fair", "weak", "unacceptable", "unspecified_identity_evidence_strength", "unknown_default_open_api"])
522
+ unless validator.valid?(nist_identity_evidence_strength)
523
+ fail ArgumentError, "invalid value for \"nist_identity_evidence_strength\", must be one of #{validator.allowable_values}."
524
+ end
525
+ @nist_identity_evidence_strength = nist_identity_evidence_strength
526
+ end
527
+
528
+ # Custom attribute writer method checking allowed values (enum).
529
+ # @param [Object] has_issuance_confirmation Object to be assigned
530
+ def has_issuance_confirmation=(has_issuance_confirmation)
531
+ validator = EnumAttributeValidator.new('String', ["true", "false", "unspecified", "unknown_default_open_api"])
532
+ unless validator.valid?(has_issuance_confirmation)
533
+ fail ArgumentError, "invalid value for \"has_issuance_confirmation\", must be one of #{validator.allowable_values}."
534
+ end
535
+ @has_issuance_confirmation = has_issuance_confirmation
536
+ end
537
+
538
+ # Custom attribute writer method checking allowed values (enum).
539
+ # @param [Object] security_tier Object to be assigned
540
+ def security_tier=(security_tier)
541
+ validator = EnumAttributeValidator.new('String', ["tier_1", "tier_2", "tier_3", "tier_4", "tier_5", "unspecified_security_tier", "unknown_default_open_api"])
542
+ unless validator.valid?(security_tier)
543
+ fail ArgumentError, "invalid value for \"security_tier\", must be one of #{validator.allowable_values}."
544
+ end
545
+ @security_tier = security_tier
546
+ end
547
+
548
+ # Checks equality by comparing each attribute.
549
+ # @param [Object] Object to be compared
550
+ def ==(o)
551
+ return true if self.equal?(o)
552
+ self.class == o.class &&
553
+ date_of_birth == o.date_of_birth &&
554
+ date_of_expiry == o.date_of_expiry &&
555
+ personal_number == o.personal_number &&
556
+ document_numbers == o.document_numbers &&
557
+ document_type == o.document_type &&
558
+ first_name == o.first_name &&
559
+ gender == o.gender &&
560
+ issuing_country == o.issuing_country &&
561
+ last_name == o.last_name &&
562
+ nationality == o.nationality &&
563
+ issuing_state == o.issuing_state &&
564
+ issuing_date == o.issuing_date &&
565
+ categorisation == o.categorisation &&
566
+ mrz_line1 == o.mrz_line1 &&
567
+ mrz_line2 == o.mrz_line2 &&
568
+ mrz_line3 == o.mrz_line3 &&
569
+ address == o.address &&
570
+ place_of_birth == o.place_of_birth &&
571
+ spouse_name == o.spouse_name &&
572
+ widow_name == o.widow_name &&
573
+ alias_name == o.alias_name &&
574
+ issuing_authority == o.issuing_authority &&
575
+ remarks == o.remarks &&
576
+ civil_state == o.civil_state &&
577
+ expatriation == o.expatriation &&
578
+ father_name == o.father_name &&
579
+ mother_name == o.mother_name &&
580
+ religion == o.religion &&
581
+ type_of_permit == o.type_of_permit &&
582
+ version_number == o.version_number &&
583
+ document_subtype == o.document_subtype &&
584
+ profession == o.profession &&
585
+ security_document_number == o.security_document_number &&
586
+ tax_number == o.tax_number &&
587
+ nist_identity_evidence_strength == o.nist_identity_evidence_strength &&
588
+ has_issuance_confirmation == o.has_issuance_confirmation &&
589
+ real_id_compliance == o.real_id_compliance &&
590
+ security_tier == o.security_tier &&
591
+ address_lines == o.address_lines &&
592
+ barcode == o.barcode &&
593
+ nfc == o.nfc &&
594
+ driving_licence_information == o.driving_licence_information &&
595
+ document_classification == o.document_classification &&
596
+ extracted_data == o.extracted_data &&
597
+ drivers_licence == o.drivers_licence &&
598
+ restricted_licence == o.restricted_licence &&
599
+ raw_licence_category == o.raw_licence_category &&
600
+ raw_vehicle_classes == o.raw_vehicle_classes &&
601
+ vehicle_class_details == o.vehicle_class_details &&
602
+ passenger_vehicle == o.passenger_vehicle
603
+ end
604
+
605
+ # @see the `==` method
606
+ # @param [Object] Object to be compared
607
+ def eql?(o)
608
+ self == o
609
+ end
610
+
611
+ # Calculates hash code according to all attributes.
612
+ # @return [Integer] Hash code
613
+ def hash
614
+ [date_of_birth, date_of_expiry, personal_number, document_numbers, document_type, first_name, gender, issuing_country, last_name, nationality, issuing_state, issuing_date, categorisation, mrz_line1, mrz_line2, mrz_line3, address, place_of_birth, spouse_name, widow_name, alias_name, issuing_authority, remarks, civil_state, expatriation, father_name, mother_name, religion, type_of_permit, version_number, document_subtype, profession, security_document_number, tax_number, nist_identity_evidence_strength, has_issuance_confirmation, real_id_compliance, security_tier, address_lines, barcode, nfc, driving_licence_information, document_classification, extracted_data, drivers_licence, restricted_licence, raw_licence_category, raw_vehicle_classes, vehicle_class_details, passenger_vehicle].hash
615
+ end
616
+
617
+ # Builds the object from hash
618
+ # @param [Hash] attributes Model attributes in the form of hash
619
+ # @return [Object] Returns the model itself
620
+ def self.build_from_hash(attributes)
621
+ return nil unless attributes.is_a?(Hash)
622
+ attributes = attributes.transform_keys(&:to_sym)
623
+ transformed_hash = {}
624
+ openapi_types.each_pair do |key, type|
625
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
626
+ transformed_hash["#{key}"] = nil
627
+ elsif type =~ /\AArray<(.*)>/i
628
+ # check to ensure the input is an array given that the attribute
629
+ # is documented as an array but the input is not
630
+ if attributes[attribute_map[key]].is_a?(Array)
631
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
632
+ end
633
+ elsif !attributes[attribute_map[key]].nil?
634
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
635
+ end
636
+ end
637
+ new(transformed_hash)
638
+ end
639
+
640
+ # Deserializes the data based on type
641
+ # @param string type Data type
642
+ # @param string value Value to be deserialized
643
+ # @return [Object] Deserialized data
644
+ def self._deserialize(type, value)
645
+ case type.to_sym
646
+ when :Time
647
+ Time.parse(value)
648
+ when :Date
649
+ Date.parse(value)
650
+ when :String
651
+ value.to_s
652
+ when :Integer
653
+ value.to_i
654
+ when :Float
655
+ value.to_f
656
+ when :Boolean
657
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
658
+ true
659
+ else
660
+ false
661
+ end
662
+ when :Object
663
+ # generic object (usually a Hash), return directly
664
+ value
665
+ when /\AArray<(?<inner_type>.+)>\z/
666
+ inner_type = Regexp.last_match[:inner_type]
667
+ value.map { |v| _deserialize(inner_type, v) }
668
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
669
+ k_type = Regexp.last_match[:k_type]
670
+ v_type = Regexp.last_match[:v_type]
671
+ {}.tap do |hash|
672
+ value.each do |k, v|
673
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
674
+ end
675
+ end
676
+ else # model
677
+ # models (e.g. Pet) or oneOf
678
+ klass = Onfido.const_get(type)
679
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
680
+ end
681
+ end
682
+
683
+ # Returns the string representation of the object
684
+ # @return [String] String presentation of the object
685
+ def to_s
686
+ to_hash.to_s
687
+ end
688
+
689
+ # to_body is an alias to to_hash (backward compatibility)
690
+ # @return [Hash] Returns the object in the form of hash
691
+ def to_body
692
+ to_hash
693
+ end
694
+
695
+ # Returns the object in the form of hash
696
+ # @return [Hash] Returns the object in the form of hash
697
+ def to_hash
698
+ hash = {}
699
+ self.class.attribute_map.each_pair do |attr, param|
700
+ value = self.send(attr)
701
+ if value.nil?
702
+ is_nullable = self.class.openapi_nullable.include?(attr)
703
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
704
+ end
705
+
706
+ hash[param] = _to_hash(value)
707
+ end
708
+ hash
709
+ end
710
+
711
+ # Outputs non-array value in the form of hash
712
+ # For object, use to_hash. Otherwise, just return the value
713
+ # @param [Object] value Any valid value
714
+ # @return [Hash] Returns the value in the form of hash
715
+ def _to_hash(value)
716
+ if value.is_a?(Array)
717
+ value.compact.map { |v| _to_hash(v) }
718
+ elsif value.is_a?(Hash)
719
+ {}.tap do |hash|
720
+ value.each { |k, v| hash[k] = _to_hash(v) }
721
+ end
722
+ elsif value.respond_to? :to_hash
723
+ value.to_hash
724
+ else
725
+ value
726
+ end
727
+ end
728
+
729
+ end
730
+
731
+ end