onfido 5.6.0 → 6.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (357) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +39 -0
  3. data/MIGRATION.md +28 -0
  4. data/README.md +18 -2
  5. data/lib/onfido/api/default_api.rb +1191 -94
  6. data/lib/onfido/api_client.rb +7 -3
  7. data/lib/onfido/api_error.rb +1 -1
  8. data/lib/onfido/configuration.rb +89 -2
  9. data/lib/onfido/models/address.rb +30 -4
  10. data/lib/onfido/models/address_builder.rb +30 -4
  11. data/lib/onfido/models/address_shared.rb +30 -4
  12. data/lib/onfido/models/addresses_list.rb +10 -4
  13. data/lib/onfido/models/applicant.rb +20 -4
  14. data/lib/onfido/models/applicant_builder.rb +10 -4
  15. data/lib/onfido/models/applicant_consent.rb +30 -4
  16. data/lib/onfido/models/applicant_consent_builder.rb +30 -4
  17. data/lib/onfido/models/applicant_consent_name.rb +1 -1
  18. data/lib/onfido/models/applicant_create.rb +10 -4
  19. data/lib/onfido/models/applicant_request.rb +10 -4
  20. data/lib/onfido/models/applicant_response.rb +20 -4
  21. data/lib/onfido/models/applicant_shared.rb +10 -4
  22. data/lib/onfido/models/applicant_update.rb +10 -4
  23. data/lib/onfido/models/applicant_updater.rb +10 -4
  24. data/lib/onfido/models/applicants_list.rb +20 -4
  25. data/lib/onfido/models/biometric_token.rb +265 -0
  26. data/lib/onfido/models/biometric_token_data.rb +317 -0
  27. data/lib/onfido/models/biometric_token_response.rb +237 -0
  28. data/lib/onfido/models/biometric_token_updater.rb +262 -0
  29. data/lib/onfido/models/biometric_tokens_response.rb +239 -0
  30. data/lib/onfido/models/check.rb +30 -4
  31. data/lib/onfido/models/check_builder.rb +30 -4
  32. data/lib/onfido/models/check_request.rb +20 -4
  33. data/lib/onfido/models/check_response.rb +20 -4
  34. data/lib/onfido/models/check_shared.rb +20 -4
  35. data/lib/onfido/models/check_status.rb +1 -1
  36. data/lib/onfido/models/checks_list.rb +20 -4
  37. data/lib/onfido/models/complete_task_builder.rb +20 -4
  38. data/lib/onfido/models/complete_task_data_builder.rb +3 -4
  39. data/lib/onfido/models/country_codes.rb +1 -1
  40. data/lib/onfido/models/device_intelligence_breakdown.rb +14 -26
  41. data/lib/onfido/models/device_intelligence_breakdown_device.rb +10 -4
  42. data/lib/onfido/models/device_intelligence_breakdown_device_breakdown.rb +10 -4
  43. data/lib/onfido/models/device_intelligence_properties.rb +13 -7
  44. data/lib/onfido/models/{device_intelligence_breakdown_properties_device.rb → device_intelligence_properties_device.rb} +33 -7
  45. data/lib/onfido/models/{device_intelligence_breakdown_properties_geolocation.rb → device_intelligence_properties_geolocation.rb} +12 -6
  46. data/lib/onfido/models/{device_intelligence_breakdown_properties_ip.rb → device_intelligence_properties_ip.rb} +12 -6
  47. data/lib/onfido/models/device_intelligence_report.rb +30 -4
  48. data/lib/onfido/models/document.rb +20 -4
  49. data/lib/onfido/models/document_breakdown.rb +10 -4
  50. data/lib/onfido/models/document_breakdown_age_validation.rb +10 -4
  51. data/lib/onfido/models/document_breakdown_age_validation_breakdown.rb +10 -4
  52. data/lib/onfido/models/document_breakdown_compromised_document.rb +10 -4
  53. data/lib/onfido/models/document_breakdown_compromised_document_breakdown.rb +10 -4
  54. data/lib/onfido/models/document_breakdown_data_comparison.rb +10 -4
  55. data/lib/onfido/models/document_breakdown_data_comparison_breakdown.rb +10 -4
  56. data/lib/onfido/models/document_breakdown_data_comparison_breakdown_issuing_country.rb +10 -4
  57. data/lib/onfido/models/document_breakdown_data_consistency.rb +10 -4
  58. data/lib/onfido/models/document_breakdown_data_consistency_breakdown.rb +10 -4
  59. data/lib/onfido/models/document_breakdown_data_validation.rb +10 -4
  60. data/lib/onfido/models/document_breakdown_data_validation_breakdown.rb +10 -4
  61. data/lib/onfido/models/document_breakdown_data_validation_breakdown_document_expiration.rb +10 -4
  62. data/lib/onfido/models/document_breakdown_data_validation_breakdown_expiry_date.rb +10 -4
  63. data/lib/onfido/models/document_breakdown_image_integrity.rb +10 -4
  64. data/lib/onfido/models/document_breakdown_image_integrity_breakdown.rb +10 -4
  65. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_colour_picture.rb +10 -4
  66. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_conclusive_document_quality.rb +10 -4
  67. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_image_quality.rb +10 -4
  68. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_supported_document.rb +10 -4
  69. data/lib/onfido/models/document_breakdown_issuing_authority.rb +10 -4
  70. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown.rb +10 -4
  71. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_active_authentication.rb +10 -4
  72. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_passive_authentication.rb +10 -4
  73. data/lib/onfido/models/document_breakdown_police_record.rb +10 -4
  74. data/lib/onfido/models/document_breakdown_visual_authenticity.rb +10 -4
  75. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown.rb +10 -4
  76. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_digital_tampering.rb +10 -4
  77. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_face_detection.rb +10 -4
  78. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_fonts.rb +10 -4
  79. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_original_document_present.rb +10 -4
  80. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_other.rb +10 -4
  81. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_picture_face_integrity.rb +10 -4
  82. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_security_features.rb +10 -4
  83. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_template.rb +10 -4
  84. data/lib/onfido/models/document_cdq_reasons.rb +10 -4
  85. data/lib/onfido/models/document_iq_reasons.rb +10 -4
  86. data/lib/onfido/models/document_odp_reasons.rb +10 -4
  87. data/lib/onfido/models/document_properties.rb +20 -16
  88. data/lib/onfido/models/document_properties_address_lines.rb +10 -4
  89. data/lib/onfido/models/document_properties_barcode_inner.rb +10 -4
  90. data/lib/onfido/models/document_properties_document_classification.rb +10 -4
  91. data/lib/onfido/models/document_properties_document_numbers_inner.rb +10 -4
  92. data/lib/onfido/models/document_properties_driving_licence_information_item.rb +10 -4
  93. data/lib/onfido/models/document_properties_extracted_data.rb +10 -4
  94. data/lib/onfido/models/document_properties_nfc.rb +10 -4
  95. data/lib/onfido/models/document_properties_with_driving_licence_information.rb +697 -0
  96. data/lib/onfido/models/document_report.rb +30 -4
  97. data/lib/onfido/models/document_report_shared.rb +10 -4
  98. data/lib/onfido/models/document_response.rb +20 -4
  99. data/lib/onfido/models/document_shared.rb +10 -4
  100. data/lib/onfido/models/document_types.rb +4 -2
  101. data/lib/onfido/models/document_video_report.rb +30 -4
  102. data/lib/onfido/models/document_video_with_address_information_report.rb +30 -4
  103. data/lib/onfido/models/document_with_address_information_report.rb +30 -4
  104. data/lib/onfido/models/document_with_driver_verification_report.rb +30 -4
  105. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb +20 -16
  106. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle.rb +10 -4
  107. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner.rb +10 -4
  108. data/lib/onfido/models/document_with_driving_licence_information_report.rb +31 -5
  109. data/lib/onfido/models/documents_list.rb +20 -4
  110. data/lib/onfido/models/error.rb +10 -4
  111. data/lib/onfido/models/error1.rb +10 -4
  112. data/lib/onfido/models/error_properties.rb +10 -4
  113. data/lib/onfido/models/error_properties1.rb +10 -4
  114. data/lib/onfido/models/extract_request.rb +20 -4
  115. data/lib/onfido/models/extraction.rb +10 -4
  116. data/lib/onfido/models/extraction_document_classification.rb +10 -4
  117. data/lib/onfido/models/extraction_extracted_data.rb +10 -4
  118. data/lib/onfido/models/facial_similarity_motion_breakdown.rb +10 -4
  119. data/lib/onfido/models/facial_similarity_motion_breakdown_face_comparison.rb +10 -4
  120. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity.rb +10 -4
  121. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown.rb +10 -4
  122. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_face_detected.rb +10 -4
  123. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_source_integrity.rb +10 -4
  124. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity.rb +10 -4
  125. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown.rb +10 -4
  126. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +10 -4
  127. data/lib/onfido/models/facial_similarity_motion_properties.rb +10 -4
  128. data/lib/onfido/models/facial_similarity_motion_report.rb +30 -4
  129. data/lib/onfido/models/facial_similarity_photo_breakdown.rb +10 -4
  130. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison.rb +10 -4
  131. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown.rb +10 -4
  132. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match.rb +10 -4
  133. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match_properties.rb +10 -4
  134. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity.rb +10 -4
  135. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown.rb +10 -4
  136. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_face_detected.rb +10 -4
  137. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_source_integrity.rb +10 -4
  138. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity.rb +10 -4
  139. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown.rb +10 -4
  140. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +10 -4
  141. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection_properties.rb +10 -4
  142. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown.rb +10 -4
  143. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity.rb +10 -4
  144. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown.rb +10 -4
  145. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity.rb +10 -4
  146. data/lib/onfido/models/facial_similarity_photo_fully_auto_properties.rb +10 -4
  147. data/lib/onfido/models/facial_similarity_photo_fully_auto_report.rb +30 -4
  148. data/lib/onfido/models/facial_similarity_photo_properties.rb +10 -4
  149. data/lib/onfido/models/facial_similarity_photo_report.rb +30 -4
  150. data/lib/onfido/models/facial_similarity_report_media.rb +20 -4
  151. data/lib/onfido/models/facial_similarity_report_shared.rb +10 -4
  152. data/lib/onfido/models/facial_similarity_video_breakdown.rb +10 -4
  153. data/lib/onfido/models/facial_similarity_video_breakdown_face_comparison.rb +10 -4
  154. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity.rb +10 -4
  155. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown.rb +10 -4
  156. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected.rb +10 -4
  157. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity.rb +10 -4
  158. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity.rb +10 -4
  159. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown.rb +10 -4
  160. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected.rb +10 -4
  161. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +10 -4
  162. data/lib/onfido/models/facial_similarity_video_properties.rb +10 -4
  163. data/lib/onfido/models/facial_similarity_video_report.rb +30 -4
  164. data/lib/onfido/models/id_number.rb +10 -4
  165. data/lib/onfido/models/id_photo.rb +20 -4
  166. data/lib/onfido/models/id_photo_response.rb +20 -4
  167. data/lib/onfido/models/id_photos_list.rb +20 -4
  168. data/lib/onfido/models/identity_enhanced_breakdown.rb +10 -4
  169. data/lib/onfido/models/identity_enhanced_breakdown_address.rb +10 -4
  170. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown.rb +10 -4
  171. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies.rb +10 -4
  172. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies_properties.rb +11 -5
  173. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_telephone_database.rb +10 -4
  174. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_voting_register.rb +10 -4
  175. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth.rb +10 -4
  176. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown.rb +10 -4
  177. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies.rb +10 -4
  178. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_voting_register.rb +10 -4
  179. data/lib/onfido/models/identity_enhanced_breakdown_mortality.rb +10 -4
  180. data/lib/onfido/models/identity_enhanced_breakdown_sources.rb +10 -4
  181. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown.rb +10 -4
  182. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources.rb +10 -4
  183. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources_properties.rb +11 -5
  184. data/lib/onfido/models/identity_enhanced_properties.rb +10 -4
  185. data/lib/onfido/models/identity_enhanced_properties_matched_addresses_inner.rb +10 -4
  186. data/lib/onfido/models/identity_enhanced_report.rb +30 -4
  187. data/lib/onfido/models/idr_ssn_breakdown.rb +10 -4
  188. data/lib/onfido/models/idr_ssn_breakdown_breakdown.rb +10 -4
  189. data/lib/onfido/models/idr_ssn_breakdown_breakdown_full_match.rb +10 -4
  190. data/lib/onfido/models/idr_ssn_breakdown_breakdown_last4_digits_match.rb +10 -4
  191. data/lib/onfido/models/india_pan_report.rb +30 -4
  192. data/lib/onfido/models/india_pan_report_all_of_breakdown.rb +10 -4
  193. data/lib/onfido/models/india_pan_report_all_of_breakdown_device.rb +10 -4
  194. data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown.rb +10 -4
  195. data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown_pan_valid.rb +10 -4
  196. data/lib/onfido/models/india_pan_report_all_of_properties.rb +10 -4
  197. data/lib/onfido/models/india_pan_report_all_of_properties_device.rb +10 -4
  198. data/lib/onfido/models/invalidated_biometric_token_response.rb +237 -0
  199. data/lib/onfido/models/invalidated_biometric_token_summary.rb +238 -0
  200. data/lib/onfido/models/invalidated_biometric_token_summary_deleted_items.rb +239 -0
  201. data/lib/onfido/models/invalidated_biometric_tokens_response.rb +237 -0
  202. data/lib/onfido/models/known_faces_breakdown.rb +10 -4
  203. data/lib/onfido/models/known_faces_breakdown_image_integrity.rb +10 -4
  204. data/lib/onfido/models/known_faces_breakdown_previously_seen_faces.rb +10 -4
  205. data/lib/onfido/models/known_faces_properties.rb +10 -4
  206. data/lib/onfido/models/known_faces_properties_matches_inner.rb +10 -4
  207. data/lib/onfido/models/known_faces_report.rb +30 -4
  208. data/lib/onfido/models/live_photo.rb +20 -4
  209. data/lib/onfido/models/live_photo_response.rb +20 -4
  210. data/lib/onfido/models/live_photos_list.rb +20 -4
  211. data/lib/onfido/models/live_video.rb +10 -4
  212. data/lib/onfido/models/live_videos_list.rb +20 -4
  213. data/lib/onfido/models/location.rb +10 -4
  214. data/lib/onfido/models/location_builder.rb +10 -4
  215. data/lib/onfido/models/location_shared.rb +10 -4
  216. data/lib/onfido/models/motion_capture.rb +10 -4
  217. data/lib/onfido/models/motion_captures_list.rb +20 -4
  218. data/lib/onfido/models/passkey.rb +353 -0
  219. data/lib/onfido/models/passkey_updater.rb +262 -0
  220. data/lib/onfido/models/passkeys_list.rb +239 -0
  221. data/lib/onfido/models/photo_auto_reasons.rb +10 -4
  222. data/lib/onfido/models/photo_reasons.rb +10 -4
  223. data/lib/onfido/models/proof_of_address_breakdown.rb +10 -4
  224. data/lib/onfido/models/proof_of_address_breakdown_data_comparison.rb +10 -4
  225. data/lib/onfido/models/proof_of_address_breakdown_data_comparison_breakdown.rb +10 -4
  226. data/lib/onfido/models/proof_of_address_breakdown_document_classification.rb +10 -4
  227. data/lib/onfido/models/proof_of_address_breakdown_document_classification_breakdown.rb +10 -4
  228. data/lib/onfido/models/proof_of_address_breakdown_image_integrity.rb +10 -4
  229. data/lib/onfido/models/proof_of_address_breakdown_image_integrity_breakdown.rb +10 -4
  230. data/lib/onfido/models/proof_of_address_properties.rb +10 -4
  231. data/lib/onfido/models/proof_of_address_report.rb +30 -4
  232. data/lib/onfido/models/repeat_attempts_list.rb +20 -4
  233. data/lib/onfido/models/repeat_attempts_list_repeat_attempts_inner.rb +10 -4
  234. data/lib/onfido/models/report.rb +1 -1
  235. data/lib/onfido/models/report_configuration.rb +10 -4
  236. data/lib/onfido/models/report_configuration_facial_similarity.rb +10 -4
  237. data/lib/onfido/models/report_document.rb +20 -4
  238. data/lib/onfido/models/report_name.rb +1 -1
  239. data/lib/onfido/models/report_result.rb +1 -1
  240. data/lib/onfido/models/report_shared.rb +30 -4
  241. data/lib/onfido/models/report_status.rb +1 -1
  242. data/lib/onfido/models/report_sub_result.rb +1 -1
  243. data/lib/onfido/models/reports_list.rb +20 -4
  244. data/lib/onfido/models/results_feedback.rb +10 -4
  245. data/lib/onfido/models/sdk_token.rb +20 -4
  246. data/lib/onfido/models/sdk_token_builder.rb +20 -4
  247. data/lib/onfido/models/sdk_token_request.rb +20 -4
  248. data/lib/onfido/models/sdk_token_response.rb +20 -4
  249. data/lib/onfido/models/signing_document.rb +316 -0
  250. data/lib/onfido/models/signing_document_response.rb +298 -0
  251. data/lib/onfido/models/{device_intelligence_breakdown_breakdown.rb → signing_document_shared.rb} +20 -13
  252. data/lib/onfido/models/signing_documents_list.rb +239 -0
  253. data/lib/onfido/models/task.rb +10 -4
  254. data/lib/onfido/models/task_item.rb +10 -4
  255. data/lib/onfido/models/timeline_file_reference.rb +30 -4
  256. data/lib/onfido/models/updated_biometric_token_response.rb +237 -0
  257. data/lib/onfido/models/us_driving_licence_breakdown.rb +10 -4
  258. data/lib/onfido/models/us_driving_licence_breakdown_address.rb +10 -4
  259. data/lib/onfido/models/us_driving_licence_breakdown_address_breakdown.rb +10 -4
  260. data/lib/onfido/models/us_driving_licence_breakdown_document.rb +10 -4
  261. data/lib/onfido/models/us_driving_licence_breakdown_document_breakdown.rb +10 -4
  262. data/lib/onfido/models/us_driving_licence_breakdown_personal.rb +10 -4
  263. data/lib/onfido/models/us_driving_licence_breakdown_personal_breakdown.rb +10 -4
  264. data/lib/onfido/models/us_driving_licence_builder.rb +20 -4
  265. data/lib/onfido/models/us_driving_licence_report.rb +30 -4
  266. data/lib/onfido/models/us_driving_licence_shared.rb +20 -4
  267. data/lib/onfido/models/video_reasons.rb +10 -4
  268. data/lib/onfido/models/watchlist_aml_breakdown.rb +10 -4
  269. data/lib/onfido/models/watchlist_aml_breakdown_adverse_media.rb +10 -4
  270. data/lib/onfido/models/watchlist_aml_breakdown_legal_and_regulatory_warnings.rb +10 -4
  271. data/lib/onfido/models/watchlist_aml_breakdown_politically_exposed_person.rb +10 -4
  272. data/lib/onfido/models/watchlist_aml_breakdown_sanction.rb +10 -4
  273. data/lib/onfido/models/watchlist_aml_properties.rb +10 -4
  274. data/lib/onfido/models/watchlist_aml_report.rb +30 -4
  275. data/lib/onfido/models/watchlist_enhanced_breakdown.rb +10 -4
  276. data/lib/onfido/models/watchlist_enhanced_properties.rb +10 -4
  277. data/lib/onfido/models/watchlist_enhanced_properties_records_inner.rb +10 -4
  278. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_address_inner.rb +10 -4
  279. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_alias_inner.rb +10 -4
  280. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_associate_inner.rb +10 -4
  281. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_attribute_inner.rb +10 -4
  282. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner.rb +10 -4
  283. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner_source.rb +10 -4
  284. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_source_inner.rb +10 -4
  285. data/lib/onfido/models/watchlist_enhanced_report.rb +30 -4
  286. data/lib/onfido/models/watchlist_mesh_added_mentions.rb +247 -0
  287. data/lib/onfido/models/watchlist_mesh_alert_risk.rb +323 -0
  288. data/lib/onfido/models/watchlist_mesh_alert_risk1.rb +316 -0
  289. data/lib/onfido/models/watchlist_mesh_associate.rb +231 -0
  290. data/lib/onfido/models/watchlist_mesh_date_value.rb +231 -0
  291. data/lib/onfido/models/{device_intelligence_breakdown_properties.rb → watchlist_mesh_field.rb} +34 -25
  292. data/lib/onfido/models/watchlist_mesh_image.rb +231 -0
  293. data/lib/onfido/models/watchlist_mesh_lists.rb +309 -0
  294. data/lib/onfido/models/watchlist_mesh_media.rb +261 -0
  295. data/lib/onfido/models/watchlist_mesh_name.rb +231 -0
  296. data/lib/onfido/models/watchlist_mesh_pep.rb +369 -0
  297. data/lib/onfido/models/watchlist_mesh_person.rb +283 -0
  298. data/lib/onfido/models/watchlist_mesh_profile.rb +273 -0
  299. data/lib/onfido/models/watchlist_mesh_risk_decision.rb +43 -0
  300. data/lib/onfido/models/watchlist_mesh_risk_detail.rb +255 -0
  301. data/lib/onfido/models/watchlist_mesh_risk_indicators.rb +271 -0
  302. data/lib/onfido/models/watchlist_mesh_sanctions.rb +309 -0
  303. data/lib/onfido/models/watchlist_monitor.rb +30 -4
  304. data/lib/onfido/models/watchlist_monitor_builder.rb +20 -4
  305. data/lib/onfido/models/watchlist_monitor_match.rb +10 -4
  306. data/lib/onfido/models/watchlist_monitor_matches_list.rb +20 -4
  307. data/lib/onfido/models/watchlist_monitor_matches_updater.rb +10 -4
  308. data/lib/onfido/models/watchlist_monitor_response.rb +20 -4
  309. data/lib/onfido/models/watchlist_monitor_shared.rb +20 -4
  310. data/lib/onfido/models/watchlist_monitors_list.rb +20 -4
  311. data/lib/onfido/models/watchlist_peps_only_report.rb +30 -4
  312. data/lib/onfido/models/watchlist_sanctions_only_report.rb +30 -4
  313. data/lib/onfido/models/watchlist_standard_breakdown.rb +10 -4
  314. data/lib/onfido/models/watchlist_standard_properties.rb +10 -4
  315. data/lib/onfido/models/watchlist_standard_report.rb +30 -4
  316. data/lib/onfido/models/webhook.rb +31 -5
  317. data/lib/onfido/models/webhook_builder.rb +31 -5
  318. data/lib/onfido/models/webhook_create.rb +31 -5
  319. data/lib/onfido/models/webhook_event.rb +10 -4
  320. data/lib/onfido/models/webhook_event_object_status.rb +1 -1
  321. data/lib/onfido/models/webhook_event_payload.rb +20 -4
  322. data/lib/onfido/models/webhook_event_payload_object.rb +20 -4
  323. data/lib/onfido/models/webhook_event_payload_resource.rb +54 -5
  324. data/lib/onfido/models/webhook_event_resource_status.rb +50 -0
  325. data/lib/onfido/models/webhook_event_resource_type.rb +1 -1
  326. data/lib/onfido/models/webhook_event_type.rb +1 -1
  327. data/lib/onfido/models/webhook_resend.rb +10 -4
  328. data/lib/onfido/models/webhook_response.rb +31 -5
  329. data/lib/onfido/models/webhook_shared.rb +10 -4
  330. data/lib/onfido/models/webhook_update.rb +21 -5
  331. data/lib/onfido/models/webhook_updater.rb +21 -5
  332. data/lib/onfido/models/webhooks_list.rb +20 -4
  333. data/lib/onfido/models/webhooks_resend_item.rb +30 -4
  334. data/lib/onfido/models/workflow_run.rb +40 -4
  335. data/lib/onfido/models/workflow_run_builder.rb +30 -4
  336. data/lib/onfido/models/workflow_run_error.rb +10 -4
  337. data/lib/onfido/models/workflow_run_link.rb +10 -4
  338. data/lib/onfido/models/workflow_run_request.rb +10 -4
  339. data/lib/onfido/models/workflow_run_response.rb +20 -4
  340. data/lib/onfido/models/workflow_run_shared.rb +30 -4
  341. data/lib/onfido/models/workflow_run_status.rb +1 -1
  342. data/lib/onfido/version.rb +2 -2
  343. data/lib/onfido.rb +40 -6
  344. data/onfido.gemspec +1 -1
  345. data/spec/integrations/biometric_token_spec.rb +122 -0
  346. data/spec/integrations/document_spec.rb +8 -1
  347. data/spec/integrations/media/nfc_data.json +11768 -0
  348. data/spec/integrations/media/sample_signing_document.pdf +33 -0
  349. data/spec/integrations/passkey_spec.rb +63 -0
  350. data/spec/integrations/signing_document_spec.rb +61 -0
  351. data/spec/integrations/watchlist_alert_risk_spec.rb +66 -0
  352. data/spec/integrations/workflow_run_spec.rb +8 -4
  353. data/spec/shared_contexts/with_document.rb +0 -1
  354. data/spec/shared_contexts/with_onfido.rb +14 -2
  355. data/spec/shared_contexts/with_signing_document.rb +15 -0
  356. data/spec/spec_helper.rb +7 -8
  357. metadata +71 -23
@@ -0,0 +1,122 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'securerandom'
4
+
5
+ require_relative '../shared_contexts/with_onfido'
6
+
7
+ describe Onfido::BiometricToken do
8
+ describe 'Biometric tokens' do
9
+ include_context 'with onfido'
10
+
11
+ let(:biometric_workflow_id) { 'b79dcf69-41a0-412d-b803-d1a618730f72' }
12
+ let(:customer_user_id) { "test-user-id-#{SecureRandom.uuid}" }
13
+ let(:unique_suffix) { SecureRandom.hex(4) }
14
+ let(:applicant_builder) do
15
+ Onfido::ApplicantBuilder.new(
16
+ first_name: "First#{unique_suffix}",
17
+ last_name: "Last#{unique_suffix}",
18
+ email: "first.last.#{unique_suffix}@example.com",
19
+ consents: [
20
+ Onfido::ApplicantConsentBuilder.new(
21
+ name: Onfido::ApplicantConsentName::PRIVACY_NOTICES_READ,
22
+ granted: true,
23
+ ),
24
+ ],
25
+ )
26
+ end
27
+ let(:applicant_id) { onfido_api.create_applicant(applicant_builder).id }
28
+ let(:live_photo_file) { File.open('spec/integrations/media/sample_photo.png') }
29
+ let(:live_photo) do
30
+ onfido_api.upload_live_photo(
31
+ applicant_id: applicant_id,
32
+ file: live_photo_file,
33
+ )
34
+ end
35
+ let(:workflow_run_builder) do
36
+ Onfido::WorkflowRunBuilder.new(
37
+ applicant_id: applicant_id,
38
+ workflow_id: biometric_workflow_id,
39
+ customer_user_id: customer_user_id,
40
+ custom_data: {
41
+ media_ids: [
42
+ {
43
+ id: live_photo.id,
44
+ },
45
+ ],
46
+ },
47
+ )
48
+ end
49
+ let(:workflow_run) { onfido_api.create_workflow_run(workflow_run_builder) }
50
+ let(:biometric_tokens) do
51
+ created_workflow_run = workflow_run
52
+
53
+ expect(created_workflow_run.customer_user_id).to eq(customer_user_id)
54
+
55
+ repeat_request_until_biometric_tokens_created(customer_user_id)
56
+ end
57
+ let(:biometric_token) { biometric_tokens.biometric_tokens.first }
58
+ let(:biometric_token_id) { biometric_token.uuid }
59
+
60
+ def repeat_request_until_biometric_tokens_created(user_id, max_retries = 10, interval = 3)
61
+ attempts = 0
62
+
63
+ loop do
64
+ response = onfido_api.list_biometric_tokens(user_id)
65
+ return response if response.biometric_tokens.any?
66
+
67
+ raise 'Biometric tokens were not created in time' if attempts >= max_retries
68
+
69
+ attempts += 1
70
+ sleep(interval)
71
+ end
72
+ end
73
+
74
+ it 'lists biometric tokens' do
75
+ expect(biometric_tokens).to be_an_instance_of(Onfido::BiometricTokensResponse)
76
+ expect(biometric_tokens.biometric_tokens.length).to be > 0
77
+ expect(biometric_token.uuid).not_to be_nil
78
+ expect(biometric_token.data.status).not_to be_nil
79
+ end
80
+
81
+ it 'finds a biometric token' do
82
+ biometric_token_response = onfido_api.find_biometric_token(customer_user_id, biometric_token_id)
83
+
84
+ expect(biometric_token_response).to be_an_instance_of(Onfido::BiometricTokenResponse)
85
+ expect(biometric_token_response.biometric_token.uuid).to eq(biometric_token_id)
86
+ expect(biometric_token_response.biometric_token.data.status).not_to be_nil
87
+ end
88
+
89
+ it 'updates a biometric token status' do
90
+ approved_status = 'approved'
91
+
92
+ updated_biometric_token = onfido_api.update_biometric_token(
93
+ customer_user_id,
94
+ biometric_token_id,
95
+ Onfido::BiometricTokenUpdater.new(status: approved_status),
96
+ )
97
+
98
+ expect(updated_biometric_token).to be_an_instance_of(Onfido::UpdatedBiometricTokenResponse)
99
+ expect(updated_biometric_token.biometric_token.uuid).to eq(biometric_token_id)
100
+ expect(updated_biometric_token.biometric_token.data.status).to eq(approved_status)
101
+ end
102
+
103
+ it 'invalidates a biometric token successfully' do
104
+ invalidated_biometric_token, status_code, = onfido_api.invalidate_biometric_token_with_http_info(
105
+ customer_user_id,
106
+ biometric_token_id,
107
+ debug_return_type: 'Object',
108
+ )
109
+
110
+ expect(invalidated_biometric_token).to be_a(Hash)
111
+ expect(status_code).to eq(200)
112
+ end
113
+
114
+ it 'invalidates biometric tokens successfully' do
115
+ invalidated_biometric_tokens, status_code, = onfido_api.invalidate_biometric_tokens_with_http_info(customer_user_id)
116
+
117
+ expect(invalidated_biometric_tokens).to be_an_instance_of(Onfido::InvalidatedBiometricTokensResponse)
118
+ expect(invalidated_biometric_tokens.biometric_tokens.deleted_items.count).to eq(0)
119
+ expect(status_code).to eq(200)
120
+ end
121
+ end
122
+ end
@@ -43,7 +43,14 @@ describe Onfido::Document do
43
43
  end
44
44
 
45
45
  describe 'downloading an NFC face' do
46
- let(:file) { onfido_api.download_nfc_face(nfc_face_id) }
46
+ let(:nfc_document) do
47
+ onfido_api.upload_document(
48
+ Onfido::DocumentTypes::PASSPORT,
49
+ applicant_id,
50
+ File.open('spec/integrations/media/nfc_data.json')
51
+ )
52
+ end
53
+ let(:file) { onfido_api.download_nfc_face(nfc_document.id) }
47
54
 
48
55
  it_behaves_like "a valid PNG file", 471345
49
56
  end