onfido 4.5.0 → 5.0.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 (308) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/MIGRATION.md +29 -0
  4. data/README.md +14 -12
  5. data/lib/onfido/api/default_api.rb +67 -5
  6. data/lib/onfido/api_client.rb +3 -2
  7. data/lib/onfido/api_error.rb +1 -1
  8. data/lib/onfido/configuration.rb +1 -1
  9. data/lib/onfido/models/address.rb +1 -1
  10. data/lib/onfido/models/address_builder.rb +1 -1
  11. data/lib/onfido/models/address_shared.rb +1 -1
  12. data/lib/onfido/models/addresses_list.rb +1 -1
  13. data/lib/onfido/models/applicant.rb +1 -1
  14. data/lib/onfido/models/applicant_builder.rb +1 -1
  15. data/lib/onfido/models/applicant_consent_builder.rb +1 -1
  16. data/lib/onfido/models/applicant_consent_name.rb +1 -1
  17. data/lib/onfido/models/applicant_create.rb +1 -1
  18. data/lib/onfido/models/applicant_request.rb +1 -1
  19. data/lib/onfido/models/applicant_response.rb +1 -1
  20. data/lib/onfido/models/applicant_shared.rb +1 -1
  21. data/lib/onfido/models/applicant_update.rb +1 -1
  22. data/lib/onfido/models/applicant_updater.rb +1 -1
  23. data/lib/onfido/models/applicants_list.rb +1 -1
  24. data/lib/onfido/models/check.rb +1 -1
  25. data/lib/onfido/models/check_builder.rb +1 -1
  26. data/lib/onfido/models/check_request.rb +1 -1
  27. data/lib/onfido/models/check_response.rb +1 -1
  28. data/lib/onfido/models/check_shared.rb +1 -1
  29. data/lib/onfido/models/check_status.rb +1 -1
  30. data/lib/onfido/models/checks_list.rb +1 -1
  31. data/lib/onfido/models/complete_task_builder.rb +1 -1
  32. data/lib/onfido/models/complete_task_data_builder.rb +1 -1
  33. data/lib/onfido/models/country_codes.rb +1 -1
  34. data/lib/onfido/models/device_intelligence_breakdown.rb +1 -1
  35. data/lib/onfido/models/device_intelligence_breakdown_breakdown.rb +1 -1
  36. data/lib/onfido/models/device_intelligence_breakdown_breakdown_device.rb +1 -1
  37. data/lib/onfido/models/device_intelligence_breakdown_breakdown_device_breakdown.rb +1 -1
  38. data/lib/onfido/models/device_intelligence_breakdown_properties.rb +1 -1
  39. data/lib/onfido/models/device_intelligence_breakdown_properties_device.rb +1 -1
  40. data/lib/onfido/models/device_intelligence_breakdown_properties_geolocation.rb +1 -1
  41. data/lib/onfido/models/device_intelligence_breakdown_properties_ip.rb +1 -1
  42. data/lib/onfido/models/device_intelligence_report.rb +2 -14
  43. data/lib/onfido/models/document.rb +1 -13
  44. data/lib/onfido/models/document_breakdown.rb +1 -1
  45. data/lib/onfido/models/document_breakdown_age_validation.rb +1 -1
  46. data/lib/onfido/models/document_breakdown_age_validation_breakdown.rb +1 -1
  47. data/lib/onfido/models/document_breakdown_compromised_document.rb +1 -1
  48. data/lib/onfido/models/document_breakdown_compromised_document_breakdown.rb +1 -1
  49. data/lib/onfido/models/document_breakdown_data_comparison.rb +1 -1
  50. data/lib/onfido/models/document_breakdown_data_comparison_breakdown.rb +1 -1
  51. data/lib/onfido/models/document_breakdown_data_comparison_breakdown_issuing_country.rb +1 -1
  52. data/lib/onfido/models/document_breakdown_data_consistency.rb +1 -1
  53. data/lib/onfido/models/document_breakdown_data_consistency_breakdown.rb +1 -1
  54. data/lib/onfido/models/document_breakdown_data_validation.rb +1 -1
  55. data/lib/onfido/models/document_breakdown_data_validation_breakdown.rb +1 -1
  56. data/lib/onfido/models/document_breakdown_data_validation_breakdown_document_expiration.rb +1 -1
  57. data/lib/onfido/models/document_breakdown_data_validation_breakdown_expiry_date.rb +1 -1
  58. data/lib/onfido/models/document_breakdown_image_integrity.rb +1 -1
  59. data/lib/onfido/models/document_breakdown_image_integrity_breakdown.rb +1 -1
  60. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_colour_picture.rb +1 -1
  61. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_conclusive_document_quality.rb +1 -1
  62. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_image_quality.rb +1 -1
  63. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_supported_document.rb +1 -1
  64. data/lib/onfido/models/document_breakdown_issuing_authority.rb +1 -1
  65. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown.rb +1 -1
  66. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_active_authentication.rb +1 -1
  67. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_passive_authentication.rb +1 -1
  68. data/lib/onfido/models/document_breakdown_police_record.rb +1 -1
  69. data/lib/onfido/models/document_breakdown_visual_authenticity.rb +1 -1
  70. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown.rb +1 -1
  71. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_digital_tampering.rb +1 -1
  72. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_face_detection.rb +1 -1
  73. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_fonts.rb +1 -1
  74. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_original_document_present.rb +1 -1
  75. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_other.rb +1 -1
  76. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_picture_face_integrity.rb +1 -1
  77. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_security_features.rb +1 -1
  78. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_template.rb +1 -1
  79. data/lib/onfido/models/document_cdq_reasons.rb +1 -1
  80. data/lib/onfido/models/document_iq_reasons.rb +1 -1
  81. data/lib/onfido/models/document_odp_reasons.rb +1 -1
  82. data/lib/onfido/models/document_properties.rb +1 -1
  83. data/lib/onfido/models/document_properties_address_lines.rb +1 -1
  84. data/lib/onfido/models/document_properties_barcode_inner.rb +1 -1
  85. data/lib/onfido/models/document_properties_document_classification.rb +1 -1
  86. data/lib/onfido/models/document_properties_document_numbers_inner.rb +1 -1
  87. data/lib/onfido/models/document_properties_driving_licence_information.rb +1 -1
  88. data/lib/onfido/models/document_properties_extracted_data.rb +1 -1
  89. data/lib/onfido/models/document_properties_nfc.rb +1 -1
  90. data/lib/onfido/models/document_report.rb +15 -14
  91. data/lib/onfido/models/document_report_shared.rb +217 -0
  92. data/lib/onfido/models/document_response.rb +1 -1
  93. data/lib/onfido/models/document_shared.rb +1 -13
  94. data/lib/onfido/models/document_types.rb +1 -1
  95. data/lib/onfido/models/document_video_report.rb +15 -14
  96. data/lib/onfido/models/document_video_with_address_information_report.rb +15 -14
  97. data/lib/onfido/models/document_with_address_information_report.rb +15 -14
  98. data/lib/onfido/models/document_with_driver_verification_report.rb +15 -14
  99. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb +1 -1
  100. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle.rb +1 -1
  101. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner.rb +1 -1
  102. data/lib/onfido/models/document_with_driving_licence_information_report.rb +15 -14
  103. data/lib/onfido/models/documents_list.rb +1 -1
  104. data/lib/onfido/models/error.rb +1 -1
  105. data/lib/onfido/models/error1.rb +1 -1
  106. data/lib/onfido/models/error_properties.rb +1 -1
  107. data/lib/onfido/models/error_properties1.rb +1 -1
  108. data/lib/onfido/models/extract_request.rb +1 -1
  109. data/lib/onfido/models/extraction.rb +1 -1
  110. data/lib/onfido/models/extraction_document_classification.rb +1 -1
  111. data/lib/onfido/models/extraction_extracted_data.rb +1 -1
  112. data/lib/onfido/models/facial_similarity_motion_breakdown.rb +1 -1
  113. data/lib/onfido/models/facial_similarity_motion_breakdown_face_comparison.rb +1 -1
  114. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity.rb +1 -1
  115. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown.rb +1 -1
  116. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_face_detected.rb +1 -1
  117. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_source_integrity.rb +1 -1
  118. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity.rb +1 -1
  119. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown.rb +1 -1
  120. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +1 -1
  121. data/lib/onfido/models/facial_similarity_motion_properties.rb +1 -1
  122. data/lib/onfido/models/facial_similarity_motion_report.rb +14 -14
  123. data/lib/onfido/models/facial_similarity_photo_breakdown.rb +1 -1
  124. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison.rb +1 -1
  125. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown.rb +1 -1
  126. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match.rb +1 -1
  127. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match_properties.rb +1 -1
  128. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity.rb +1 -1
  129. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown.rb +1 -1
  130. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_face_detected.rb +1 -1
  131. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_source_integrity.rb +1 -1
  132. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity.rb +1 -1
  133. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown.rb +1 -1
  134. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +1 -1
  135. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection_properties.rb +1 -1
  136. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown.rb +1 -1
  137. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity.rb +1 -1
  138. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown.rb +1 -1
  139. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity.rb +1 -1
  140. data/lib/onfido/models/facial_similarity_photo_fully_auto_properties.rb +1 -1
  141. data/lib/onfido/models/facial_similarity_photo_fully_auto_report.rb +14 -14
  142. data/lib/onfido/models/facial_similarity_photo_properties.rb +1 -1
  143. data/lib/onfido/models/facial_similarity_photo_report.rb +14 -14
  144. data/lib/onfido/models/facial_similarity_report_media.rb +1 -1
  145. data/lib/onfido/models/facial_similarity_report_shared.rb +14 -2
  146. data/lib/onfido/models/facial_similarity_video_breakdown.rb +1 -1
  147. data/lib/onfido/models/facial_similarity_video_breakdown_face_comparison.rb +1 -1
  148. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity.rb +1 -1
  149. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown.rb +1 -1
  150. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected.rb +1 -1
  151. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity.rb +1 -1
  152. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity.rb +1 -1
  153. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown.rb +1 -1
  154. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected.rb +1 -1
  155. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +1 -1
  156. data/lib/onfido/models/facial_similarity_video_properties.rb +1 -1
  157. data/lib/onfido/models/facial_similarity_video_report.rb +14 -14
  158. data/lib/onfido/models/id_number.rb +3 -3
  159. data/lib/onfido/models/id_photo.rb +1 -1
  160. data/lib/onfido/models/id_photo_response.rb +1 -1
  161. data/lib/onfido/models/id_photos_list.rb +1 -1
  162. data/lib/onfido/models/identity_enhanced_breakdown.rb +1 -1
  163. data/lib/onfido/models/identity_enhanced_breakdown_address.rb +1 -1
  164. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown.rb +1 -1
  165. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies.rb +1 -1
  166. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies_properties.rb +1 -1
  167. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_telephone_database.rb +1 -1
  168. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_voting_register.rb +1 -1
  169. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth.rb +1 -1
  170. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown.rb +1 -1
  171. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies.rb +1 -1
  172. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_voting_register.rb +1 -1
  173. data/lib/onfido/models/identity_enhanced_breakdown_mortality.rb +1 -1
  174. data/lib/onfido/models/identity_enhanced_breakdown_sources.rb +1 -1
  175. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown.rb +1 -1
  176. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources.rb +1 -1
  177. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources_properties.rb +1 -1
  178. data/lib/onfido/models/identity_enhanced_properties.rb +1 -1
  179. data/lib/onfido/models/identity_enhanced_properties_matched_addresses_inner.rb +1 -1
  180. data/lib/onfido/models/identity_enhanced_report.rb +2 -14
  181. data/lib/onfido/models/india_pan_report.rb +2 -14
  182. data/lib/onfido/models/india_pan_report_all_of_breakdown.rb +1 -1
  183. data/lib/onfido/models/india_pan_report_all_of_breakdown_device.rb +1 -1
  184. data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown.rb +1 -1
  185. data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown_pan_valid.rb +1 -1
  186. data/lib/onfido/models/india_pan_report_all_of_properties.rb +1 -1
  187. data/lib/onfido/models/india_pan_report_all_of_properties_device.rb +1 -1
  188. data/lib/onfido/models/known_faces_breakdown.rb +1 -1
  189. data/lib/onfido/models/known_faces_breakdown_image_integrity.rb +1 -1
  190. data/lib/onfido/models/known_faces_breakdown_previously_seen_faces.rb +1 -1
  191. data/lib/onfido/models/known_faces_properties.rb +1 -1
  192. data/lib/onfido/models/known_faces_properties_matches_inner.rb +1 -1
  193. data/lib/onfido/models/known_faces_report.rb +2 -14
  194. data/lib/onfido/models/live_photo.rb +1 -1
  195. data/lib/onfido/models/live_photo_response.rb +1 -1
  196. data/lib/onfido/models/live_photos_list.rb +1 -1
  197. data/lib/onfido/models/live_video.rb +1 -1
  198. data/lib/onfido/models/live_videos_list.rb +1 -1
  199. data/lib/onfido/models/location.rb +1 -1
  200. data/lib/onfido/models/location_builder.rb +1 -1
  201. data/lib/onfido/models/location_shared.rb +1 -1
  202. data/lib/onfido/models/motion_capture.rb +1 -1
  203. data/lib/onfido/models/motion_captures_list.rb +1 -1
  204. data/lib/onfido/models/photo_auto_reasons.rb +1 -1
  205. data/lib/onfido/models/photo_reasons.rb +1 -1
  206. data/lib/onfido/models/proof_of_address_breakdown.rb +1 -1
  207. data/lib/onfido/models/proof_of_address_breakdown_data_comparison.rb +1 -1
  208. data/lib/onfido/models/proof_of_address_breakdown_data_comparison_breakdown.rb +1 -1
  209. data/lib/onfido/models/proof_of_address_breakdown_document_classification.rb +1 -1
  210. data/lib/onfido/models/proof_of_address_breakdown_document_classification_breakdown.rb +1 -1
  211. data/lib/onfido/models/proof_of_address_breakdown_image_integrity.rb +1 -1
  212. data/lib/onfido/models/proof_of_address_breakdown_image_integrity_breakdown.rb +1 -1
  213. data/lib/onfido/models/proof_of_address_properties.rb +1 -1
  214. data/lib/onfido/models/proof_of_address_report.rb +2 -14
  215. data/lib/onfido/models/repeat_attempts_list.rb +1 -1
  216. data/lib/onfido/models/repeat_attempts_list_repeat_attempts_inner.rb +1 -1
  217. data/lib/onfido/models/report.rb +1 -1
  218. data/lib/onfido/models/report_document.rb +1 -1
  219. data/lib/onfido/models/report_name.rb +1 -1
  220. data/lib/onfido/models/report_result.rb +1 -1
  221. data/lib/onfido/models/report_shared.rb +2 -14
  222. data/lib/onfido/models/report_status.rb +1 -1
  223. data/lib/onfido/models/report_sub_result.rb +1 -1
  224. data/lib/onfido/models/reports_list.rb +1 -1
  225. data/lib/onfido/models/results_feedback.rb +1 -1
  226. data/lib/onfido/models/sdk_token.rb +1 -1
  227. data/lib/onfido/models/sdk_token_builder.rb +1 -1
  228. data/lib/onfido/models/sdk_token_request.rb +1 -1
  229. data/lib/onfido/models/sdk_token_response.rb +1 -1
  230. data/lib/onfido/models/task.rb +1 -1
  231. data/lib/onfido/models/task_item.rb +1 -1
  232. data/lib/onfido/models/timeline_file_reference.rb +1 -1
  233. data/lib/onfido/models/us_driving_licence_breakdown.rb +1 -1
  234. data/lib/onfido/models/us_driving_licence_breakdown_address.rb +1 -1
  235. data/lib/onfido/models/us_driving_licence_breakdown_address_breakdown.rb +1 -1
  236. data/lib/onfido/models/us_driving_licence_breakdown_document.rb +1 -1
  237. data/lib/onfido/models/us_driving_licence_breakdown_document_breakdown.rb +1 -1
  238. data/lib/onfido/models/us_driving_licence_breakdown_personal.rb +1 -1
  239. data/lib/onfido/models/us_driving_licence_breakdown_personal_breakdown.rb +1 -1
  240. data/lib/onfido/models/us_driving_licence_builder.rb +1 -1
  241. data/lib/onfido/models/us_driving_licence_report.rb +2 -14
  242. data/lib/onfido/models/us_driving_licence_shared.rb +1 -1
  243. data/lib/onfido/models/video_reasons.rb +1 -1
  244. data/lib/onfido/models/watchlist_aml_breakdown.rb +1 -1
  245. data/lib/onfido/models/watchlist_aml_breakdown_adverse_media.rb +1 -1
  246. data/lib/onfido/models/watchlist_aml_breakdown_legal_and_regulatory_warnings.rb +1 -1
  247. data/lib/onfido/models/watchlist_aml_breakdown_politically_exposed_person.rb +1 -1
  248. data/lib/onfido/models/watchlist_aml_breakdown_sanction.rb +1 -1
  249. data/lib/onfido/models/watchlist_aml_properties.rb +2 -2
  250. data/lib/onfido/models/watchlist_aml_report.rb +2 -14
  251. data/lib/onfido/models/watchlist_enhanced_breakdown.rb +1 -1
  252. data/lib/onfido/models/watchlist_enhanced_properties.rb +1 -1
  253. data/lib/onfido/models/watchlist_enhanced_properties_records_inner.rb +1 -1
  254. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_address_inner.rb +1 -1
  255. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_alias_inner.rb +1 -1
  256. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_associate_inner.rb +1 -1
  257. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_attribute_inner.rb +1 -1
  258. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner.rb +1 -1
  259. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner_source.rb +1 -1
  260. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_source_inner.rb +1 -1
  261. data/lib/onfido/models/watchlist_enhanced_report.rb +2 -14
  262. data/lib/onfido/models/watchlist_monitor.rb +1 -1
  263. data/lib/onfido/models/watchlist_monitor_builder.rb +1 -1
  264. data/lib/onfido/models/watchlist_monitor_match.rb +1 -1
  265. data/lib/onfido/models/watchlist_monitor_matches_list.rb +1 -1
  266. data/lib/onfido/models/watchlist_monitor_matches_updater.rb +1 -1
  267. data/lib/onfido/models/watchlist_monitor_response.rb +1 -1
  268. data/lib/onfido/models/watchlist_monitor_shared.rb +1 -1
  269. data/lib/onfido/models/watchlist_monitors_list.rb +1 -1
  270. data/lib/onfido/models/watchlist_peps_only_report.rb +2 -14
  271. data/lib/onfido/models/watchlist_sanctions_only_report.rb +2 -14
  272. data/lib/onfido/models/watchlist_standard_breakdown.rb +1 -1
  273. data/lib/onfido/models/watchlist_standard_properties.rb +2 -2
  274. data/lib/onfido/models/watchlist_standard_report.rb +2 -14
  275. data/lib/onfido/models/webhook.rb +1 -1
  276. data/lib/onfido/models/webhook_builder.rb +1 -1
  277. data/lib/onfido/models/webhook_create.rb +1 -1
  278. data/lib/onfido/models/webhook_event.rb +1 -1
  279. data/lib/onfido/models/webhook_event_object_status.rb +1 -1
  280. data/lib/onfido/models/webhook_event_payload.rb +1 -1
  281. data/lib/onfido/models/webhook_event_payload_object.rb +1 -8
  282. data/lib/onfido/models/webhook_event_payload_resource.rb +34 -5
  283. data/lib/onfido/models/webhook_event_resource_type.rb +1 -1
  284. data/lib/onfido/models/webhook_event_type.rb +2 -3
  285. data/lib/onfido/models/webhook_resend.rb +1 -1
  286. data/lib/onfido/models/webhook_response.rb +1 -1
  287. data/lib/onfido/models/webhook_shared.rb +1 -1
  288. data/lib/onfido/models/webhook_update.rb +1 -1
  289. data/lib/onfido/models/webhook_updater.rb +1 -1
  290. data/lib/onfido/models/webhooks_list.rb +1 -1
  291. data/lib/onfido/models/webhooks_resend_item.rb +1 -1
  292. data/lib/onfido/models/workflow_run.rb +1 -1
  293. data/lib/onfido/models/workflow_run_builder.rb +1 -1
  294. data/lib/onfido/models/workflow_run_error.rb +1 -1
  295. data/lib/onfido/models/workflow_run_link.rb +1 -1
  296. data/lib/onfido/models/workflow_run_request.rb +1 -1
  297. data/lib/onfido/models/workflow_run_response.rb +1 -1
  298. data/lib/onfido/models/workflow_run_shared.rb +1 -1
  299. data/lib/onfido/models/workflow_run_status.rb +1 -1
  300. data/lib/onfido/version.rb +2 -2
  301. data/lib/onfido.rb +2 -1
  302. data/onfido.gemspec +1 -1
  303. data/spec/integrations/document_spec.rb +14 -2
  304. data/spec/integrations/report_spec.rb +4 -2
  305. data/spec/integrations/workflow_run_spec.rb +3 -1
  306. data/spec/shared_contexts/with_document.rb +4 -0
  307. data/spec/spec_helper.rb +3 -3
  308. metadata +20 -19
@@ -34,13 +34,25 @@ describe Onfido::Document do
34
34
  end
35
35
 
36
36
  it 'cannot download an inexistent document' do
37
- inexistent_document_id = '00000000-0000-0000-0000-000000000000'
38
-
39
37
  expect {
40
38
  onfido_api.download_document(inexistent_document_id)
41
39
  }.to raise_error(Onfido::ApiError) { |e|
42
40
  expect(e.code).to eq(404)
43
41
  }
44
42
  end
43
+
44
+ it 'downloads an NFC face' do
45
+ file = onfido_api.download_nfc_face(nfc_face_id)
46
+
47
+ expect(file.size).to be > 0
48
+ end
49
+
50
+ it 'cannot download an inexistent NFC face' do
51
+ expect {
52
+ onfido_api.download_nfc_face(inexistent_document_id)
53
+ }.to raise_error(Onfido::ApiError) { |e|
54
+ expect(e.code).to eq(404)
55
+ }
56
+ end
45
57
  end
46
58
  end
@@ -23,13 +23,15 @@ describe Onfido::Report do
23
23
  end
24
24
 
25
25
  it 'finds a report' do
26
- get_document_report = onfido_api.find_report(document_report_id)
26
+ get_document_report = repeat_request_until_status_changes(Onfido::ReportStatus::COMPLETE) {
27
+ onfido_api.find_report(document_report_id)
28
+ }
27
29
  get_identity_report = onfido_api.find_report(identity_report_id)
28
30
 
29
31
  expect(get_document_report).to be_an_instance_of Onfido::DocumentReport
30
32
  expect(get_document_report.id).to eq document_report_id
31
33
  expect(get_document_report.name).to eq Onfido::ReportName::DOCUMENT
32
- expect(get_document_report.status).to eq Onfido::ReportStatus::AWAITING_DATA
34
+ expect(get_document_report.status).to eq Onfido::ReportStatus::COMPLETE
33
35
 
34
36
  expect(get_identity_report).to be_an_instance_of Onfido::IdentityEnhancedReport
35
37
  expect(get_identity_report.id).to eq identity_report_id
@@ -82,7 +82,9 @@ describe Onfido::WorkflowRun do
82
82
  end
83
83
 
84
84
  it 'downloads an evidence folder' do
85
- file = onfido_api.download_evidence_folder(workflow_run_id)
85
+ file = repeat_request_unti_http_code_changes do
86
+ onfido_api.download_evidence_folder(workflow_run_id)
87
+ end
86
88
 
87
89
  Zip::File.open(file.path) do |zip|
88
90
  expect(zip.entries.size).to be > 0
@@ -10,4 +10,8 @@ RSpec.shared_context 'with document', shared_context: :metadata do
10
10
 
11
11
  let(:document) { onfido_api.upload_document(Onfido::DocumentTypes::PASSPORT, applicant_id, document_file) }
12
12
  let!(:document_id) { document.id }
13
+
14
+ let(:nfc_face_id) { 'cc2dc25f-2df6-4f8f-a5aa-60f49cef9b3c' }
15
+
16
+ let(:inexistent_document_id) { '00000000-0000-0000-0000-000000000000' }
13
17
  end
data/spec/spec_helper.rb CHANGED
@@ -65,7 +65,7 @@ RSpec.configure do |config|
65
65
  Kernel.srand config.seed
66
66
  end
67
67
 
68
- def repeat_request_until_status_changes(expected_status, max_retries = 10,
68
+ def repeat_request_until_status_changes(expected_status, max_retries = 15,
69
69
  interval = 1, &proc)
70
70
  # expected_status --> desired status
71
71
  # max_retries --> how many times to retry the request
@@ -86,7 +86,7 @@ def repeat_request_until_status_changes(expected_status, max_retries = 10,
86
86
  instance
87
87
  end
88
88
 
89
- def repeat_request_until_task_output_changes(max_retries = 10,
89
+ def repeat_request_until_task_output_changes(max_retries = 15,
90
90
  interval = 1, &proc)
91
91
  # max_retries --> how many times to retry the request
92
92
  # interval --> how many seconds to wait until the next retry
@@ -106,7 +106,7 @@ def repeat_request_until_task_output_changes(max_retries = 10,
106
106
  instance
107
107
  end
108
108
 
109
- def repeat_request_unti_http_code_changes(max_retries = 10,
109
+ def repeat_request_unti_http_code_changes(max_retries = 15,
110
110
  interval = 1, &proc)
111
111
  # max_retries --> how many times to retry the request
112
112
  # interval --> how many seconds to wait until the next retry
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: onfido
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.5.0
4
+ version: 5.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenAPI-Generator
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-01-08 00:00:00.000000000 Z
11
+ date: 2025-02-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -220,6 +220,7 @@ files:
220
220
  - lib/onfido/models/document_properties_extracted_data.rb
221
221
  - lib/onfido/models/document_properties_nfc.rb
222
222
  - lib/onfido/models/document_report.rb
223
+ - lib/onfido/models/document_report_shared.rb
223
224
  - lib/onfido/models/document_response.rb
224
225
  - lib/onfido/models/document_shared.rb
225
226
  - lib/onfido/models/document_types.rb
@@ -487,33 +488,33 @@ specification_version: 4
487
488
  summary: The official Ruby library for integrating with the Onfido API.
488
489
  test_files:
489
490
  - spec/classic_webhook_event_verifier_spec.rb
490
- - spec/integrations/report_schema_spec.rb
491
491
  - spec/integrations/sdk_token_spec.rb
492
- - spec/integrations/applicant_spec.rb
493
- - spec/integrations/workflow_run_spec.rb
492
+ - spec/integrations/address_picker_spec.rb
493
+ - spec/integrations/tasks_spec.rb
494
494
  - spec/integrations/workflow_run_output_spec.rb
495
- - spec/integrations/webhook_spec.rb
496
495
  - spec/integrations/watchlist_monitor_spec.rb
497
- - spec/integrations/live_video_spec.rb
498
- - spec/integrations/document_spec.rb
499
- - spec/integrations/live_photo_spec.rb
496
+ - spec/integrations/report_schema_spec.rb
497
+ - spec/integrations/applicant_spec.rb
500
498
  - spec/integrations/qualified_electronic_signature_spec.rb
501
499
  - spec/integrations/motion_capture_spec.rb
502
- - spec/integrations/address_picker_spec.rb
503
- - spec/integrations/tasks_spec.rb
504
- - spec/integrations/media/sample_photo.png
500
+ - spec/integrations/report_spec.rb
505
501
  - spec/integrations/media/sample_driving_licence.png
502
+ - spec/integrations/media/sample_photo.png
503
+ - spec/integrations/extraction_spec.rb
504
+ - spec/integrations/webhook_spec.rb
506
505
  - spec/integrations/check_spec.rb
506
+ - spec/integrations/live_video_spec.rb
507
507
  - spec/integrations/id_photo_spec.rb
508
- - spec/integrations/extraction_spec.rb
509
- - spec/integrations/report_spec.rb
510
- - spec/media/studio_webhook_event_with_object_in_output.json
508
+ - spec/integrations/workflow_run_spec.rb
509
+ - spec/integrations/document_spec.rb
510
+ - spec/integrations/live_photo_spec.rb
511
511
  - spec/media/studio_webhook_event_with_list_in_output.json
512
- - spec/shared_contexts/with_document.rb
513
- - spec/shared_contexts/with_check.rb
514
- - spec/shared_contexts/with_workflow_run.rb
515
- - spec/shared_contexts/with_applicant.rb
512
+ - spec/media/studio_webhook_event_with_object_in_output.json
516
513
  - spec/shared_contexts/with_live_photo.rb
517
514
  - spec/shared_contexts/with_onfido.rb
515
+ - spec/shared_contexts/with_applicant.rb
516
+ - spec/shared_contexts/with_document.rb
517
+ - spec/shared_contexts/with_workflow_run.rb
518
+ - spec/shared_contexts/with_check.rb
518
519
  - spec/spec_helper.rb
519
520
  - spec/studio_webhook_event_verifier_spec.rb