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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 64d5f592bf0aa8a4fbea4bddf86de25c7b1a1341fbfee3066bae162fff656139
4
- data.tar.gz: 93f9faf94388a9d161068c2220b3ec2cf2813cefa1b3c6bf9974ef1652fcee3b
3
+ metadata.gz: e12865830296f564d8b260c71944db655a54ea3e936d49e884604c1dac5f5004
4
+ data.tar.gz: 7924185844e0d402651d07fb9dfb05cb82564d1aa73dfc511629ca64cc41f36f
5
5
  SHA512:
6
- metadata.gz: 6b21fc206f619a85cd0422fd72dac56b953dcdf8f0270f32bfd276dc8cde052a27bb047bf8abe48571ab2f024a6bf24adcfa05d8831227a4cf23755bc4804329
7
- data.tar.gz: 36edbbc7bec1113b35ba8d8974ddd57d70a25f307333c737c8d0d88576192e687b9ffe671d414662fe965405c05f9fb889b540713f9431a09d7b1a41c0782134
6
+ metadata.gz: 874496bd9bab433e899eef7f4d688853c67fc907ac1fbee6059788a905a6b0090d84ab07b990fe24c77e498f1f0a590899aa5f6638ecf4945c0d0ec93fef4e3f
7
+ data.tar.gz: 613aa1333a9c2314a9adf1d30e112e94280d04f45e13d5339a4de2bbde351d2971d3816e8b6a5c38c572d376906af2e0386ea34614b774e9c92746213d0aa3dd
data/CHANGELOG.md CHANGED
@@ -1,5 +1,44 @@
1
1
  # Changelog
2
2
 
3
+ ## v6.2.0 21st May 2026
4
+
5
+ - Release based on Onfido OpenAPI spec version [v6.1.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v6.1.0):
6
+ - Add Oauth2ClientCredentials support
7
+ - Fix ruby oauth token exchange url
8
+
9
+ ## v6.1.0 6th May 2026
10
+
11
+ - Release based on Onfido OpenAPI spec version [v6.0.1](https://github.com/onfido/onfido-openapi-spec/releases/tag/v6.0.1):
12
+ - BIO-8421] Document two new number_of_ip_reuse_reports fields
13
+ - Fix flaky timeline file spec
14
+
15
+ ## v6.0.0 19th February 2026
16
+
17
+ - Release based on Onfido OpenAPI spec version [v6.0.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v6.0.0):
18
+ - [CAT-1911] Remove driving licence information properties where not needed
19
+ - [AF-1390] Remove deprecated breakdown.breakdown property
20
+ - [SIG-3390] IDR: change total_number_of_sources and number_of_matches to string
21
+ - Add missing tags field for workflow run listing and webhook
22
+ - [STUDIO-5708] Fix workflow_runs date filter parameters format
23
+ - Remove deprecated properties object from device_intelligence_breakdown
24
+ - [STUDIO-5734] Add status to webhook event resource
25
+ - Bump openapi-generator-cli from v7.11.0 to v7.16.0
26
+
27
+ ## v5.7.0 3rd February 2026
28
+
29
+ - Release based on Onfido OpenAPI spec version [v5.7.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.7.0):
30
+ - [ENT-129] Add new passkey management endpoints
31
+ - [ENT-114] Add signing document endpoints
32
+ - [DEXTV2-10857] Add valid_from field to open API spec for document report properties
33
+
34
+ ## v5.6.0 15th January 2026
35
+
36
+ - Release based on Onfido OpenAPI spec version [v5.6.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.6.0):
37
+ - [SIG-3270] Update document_type supported by PoA
38
+ - [DEXTV2-9337] Update list of document subtypes for extraction
39
+ - [STUDIO-5634] Add timeline_file_download_url to the webhook event resource
40
+ - Update faraday-follow_redirects and unblock Ruby 4.0
41
+
3
42
  ## v5.5.0 22nd September 2025
4
43
 
5
44
  - Release based on Onfido OpenAPI spec version [v5.5.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.5.0):
data/MIGRATION.md CHANGED
@@ -6,6 +6,34 @@ major versions of the client library.
6
6
  It covers changes in core resources, other endpoints, and the OpenAPI generator,
7
7
  ensuring a smooth transition between versions.
8
8
 
9
+ ## Upgrading from 5.x to 6.x
10
+
11
+ ### Core Resources
12
+
13
+ - Documents
14
+ - Driving licence information properties removed from general `DocumentProperties`
15
+ and moved to new `DocumentPropertiesWithDrivingLicenceInformation` class
16
+ - Workflow Runs
17
+ - `created_at_gt` and `created_at_lt` parameters in `list_workflow_runs` changed from
18
+ date-time format to date format (YYYY-MM-DD)
19
+
20
+ ### Other Endpoints
21
+
22
+ - Reports
23
+ - Device Intelligence: Removed deprecated `breakdown` property and related
24
+ breakdown classes:
25
+ - `DeviceIntelligenceBreakdownBreakdown` removed
26
+ - `DeviceIntelligenceBreakdownProperties` → `DeviceIntelligenceProperties`
27
+ - `DeviceIntelligenceBreakdownPropertiesDevice` → `DeviceIntelligencePropertiesDevice`
28
+ - `DeviceIntelligenceBreakdownPropertiesGeolocation` → `DeviceIntelligencePropertiesGeolocation`
29
+ - `DeviceIntelligenceBreakdownPropertiesIp` → `DeviceIntelligencePropertiesIp`
30
+ - Identity Enhanced: Changed `total_number_of_sources` and `number_of_matches` from
31
+ number to string type
32
+
33
+ ### OpenAPI generator
34
+
35
+ - Version upgraded from `7.11.0` to `7.16.0`
36
+
9
37
  ## Upgrading from 4.x to 5.x
10
38
 
11
39
  ### Core Resources
data/README.md CHANGED
@@ -14,7 +14,7 @@ This version uses Onfido API v3.6. Refer to our [API versioning guide](https://d
14
14
  ### Installation
15
15
 
16
16
  ```ruby
17
- gem 'onfido', '~> 5.6.0'
17
+ gem 'onfido', '~> 6.3.0'
18
18
  ```
19
19
 
20
20
  Configure with your API token, region and optional timeout (default value is 30):
@@ -31,6 +31,22 @@ end
31
31
  onfido_api = Onfido::DefaultApi.new
32
32
  ```
33
33
 
34
+ You can also authenticate using OAuth2 client credentials instead of an API token:
35
+
36
+ ```ruby
37
+ require 'onfido'
38
+
39
+ Onfido.configure do |config|
40
+ config.set_oauth_credentials(ENV["ONFIDO_OAUTH_CLIENT_ID"], ENV["ONFIDO_OAUTH_CLIENT_SECRET"])
41
+ config.region = config.region[:EU]
42
+ config.timeout = 30
43
+ end
44
+
45
+ onfido_api = Onfido::DefaultApi.new
46
+ ```
47
+
48
+ The client will automatically exchange credentials for an access token and refresh it when it expires.
49
+
34
50
  All resources share the same interface when making API calls. Use `.create` to create a resource, `.find` to find one, and `.all` to fetch all resources.
35
51
 
36
52
  ### Making a call to the API
@@ -86,7 +102,7 @@ Webhook events payload needs to be verified before it can be accessed. Verifying
86
102
 
87
103
  ## Contributing
88
104
 
89
- This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.11.0); therefore, all contributions (except test files) should target the [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository. Please follow the contribution guidelines provided in the OpenAPI specification repository.
105
+ This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.16.0); therefore, all contributions (except test files) should target the [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository. Please follow the contribution guidelines provided in the OpenAPI specification repository.
90
106
 
91
107
  For contributions to the tests instead, please follow the steps below:
92
108