onfido 3.4.0 → 4.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (311) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/MIGRATION.md +30 -0
  4. data/README.md +2 -2
  5. data/lib/onfido/api/default_api.rb +68 -68
  6. data/lib/onfido/api_client.rb +31 -25
  7. data/lib/onfido/api_error.rb +1 -1
  8. data/lib/onfido/configuration.rb +11 -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 +6 -3
  15. data/lib/onfido/models/{consent_item.rb → applicant_consent_builder.rb} +5 -18
  16. data/lib/onfido/models/applicant_consent_name.rb +42 -0
  17. data/lib/onfido/models/applicant_create.rb +1 -1
  18. data/lib/onfido/models/applicant_request.rb +6 -3
  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 +6 -3
  23. data/lib/onfido/models/applicants_list.rb +1 -1
  24. data/lib/onfido/models/check.rb +33 -19
  25. data/lib/onfido/models/check_builder.rb +11 -2
  26. data/lib/onfido/models/check_request.rb +1 -1
  27. data/lib/onfido/models/check_response.rb +24 -19
  28. data/lib/onfido/models/check_shared.rb +14 -5
  29. data/lib/onfido/models/check_status.rb +45 -0
  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 +2 -42
  40. data/lib/onfido/models/device_intelligence_breakdown_properties_geolocation.rb +1 -1
  41. data/lib/onfido/models/device_intelligence_breakdown_properties_ip.rb +5 -35
  42. data/lib/onfido/models/device_intelligence_report.rb +1 -1
  43. data/lib/onfido/models/document.rb +2 -2
  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 +3 -5
  83. data/lib/onfido/models/document_properties_address_lines.rb +1 -1
  84. data/lib/onfido/models/{document_properties_barcode_inner.rb → document_properties_barcode.rb} +4 -4
  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 +1 -1
  91. data/lib/onfido/models/document_response.rb +1 -1
  92. data/lib/onfido/models/document_shared.rb +2 -2
  93. data/lib/onfido/models/document_types.rb +7 -2
  94. data/lib/onfido/models/document_video_report.rb +1 -1
  95. data/lib/onfido/models/document_video_with_address_information_report.rb +1 -1
  96. data/lib/onfido/models/document_with_address_information_report.rb +1 -1
  97. data/lib/onfido/models/document_with_driver_verification_report.rb +1 -1
  98. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb +3 -5
  99. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle.rb +1 -1
  100. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner.rb +1 -1
  101. data/lib/onfido/models/document_with_driving_licence_information_report.rb +1 -1
  102. data/lib/onfido/models/documents_list.rb +1 -1
  103. data/lib/onfido/models/error.rb +1 -1
  104. data/lib/onfido/models/error1.rb +1 -1
  105. data/lib/onfido/models/error_properties.rb +1 -1
  106. data/lib/onfido/models/error_properties1.rb +1 -1
  107. data/lib/onfido/models/extract_request.rb +1 -1
  108. data/lib/onfido/models/extraction.rb +1 -1
  109. data/lib/onfido/models/extraction_document_classification.rb +1 -1
  110. data/lib/onfido/models/extraction_extracted_data.rb +1 -1
  111. data/lib/onfido/models/facial_similarity_motion_breakdown.rb +1 -1
  112. data/lib/onfido/models/facial_similarity_motion_breakdown_face_comparison.rb +1 -1
  113. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity.rb +1 -1
  114. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown.rb +1 -1
  115. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_face_detected.rb +1 -1
  116. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_source_integrity.rb +1 -1
  117. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity.rb +1 -1
  118. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown.rb +1 -1
  119. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +1 -1
  120. data/lib/onfido/models/facial_similarity_motion_properties.rb +1 -1
  121. data/lib/onfido/models/facial_similarity_motion_report.rb +1 -1
  122. data/lib/onfido/models/facial_similarity_photo_breakdown.rb +1 -1
  123. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison.rb +1 -1
  124. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown.rb +1 -1
  125. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match.rb +1 -1
  126. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match_properties.rb +1 -1
  127. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity.rb +1 -1
  128. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown.rb +1 -1
  129. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_face_detected.rb +1 -1
  130. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_source_integrity.rb +1 -1
  131. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity.rb +1 -1
  132. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown.rb +1 -1
  133. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +1 -1
  134. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection_properties.rb +1 -1
  135. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown.rb +1 -1
  136. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity.rb +1 -1
  137. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown.rb +1 -1
  138. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity.rb +1 -1
  139. data/lib/onfido/models/facial_similarity_photo_fully_auto_properties.rb +1 -1
  140. data/lib/onfido/models/facial_similarity_photo_fully_auto_report.rb +1 -1
  141. data/lib/onfido/models/facial_similarity_photo_properties.rb +1 -1
  142. data/lib/onfido/models/facial_similarity_photo_report.rb +1 -1
  143. data/lib/onfido/models/facial_similarity_video_breakdown.rb +1 -1
  144. data/lib/onfido/models/facial_similarity_video_breakdown_face_comparison.rb +1 -1
  145. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity.rb +1 -1
  146. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown.rb +1 -1
  147. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected.rb +1 -1
  148. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity.rb +1 -1
  149. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity.rb +1 -1
  150. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown.rb +1 -1
  151. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected.rb +1 -1
  152. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +1 -1
  153. data/lib/onfido/models/facial_similarity_video_properties.rb +1 -1
  154. data/lib/onfido/models/facial_similarity_video_report.rb +1 -1
  155. data/lib/onfido/models/id_number.rb +1 -1
  156. data/lib/onfido/models/id_photo.rb +1 -1
  157. data/lib/onfido/models/id_photo_response.rb +1 -1
  158. data/lib/onfido/models/id_photos_list.rb +1 -1
  159. data/lib/onfido/models/identity_enhanced_breakdown.rb +1 -1
  160. data/lib/onfido/models/identity_enhanced_breakdown_address.rb +1 -1
  161. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown.rb +1 -1
  162. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies.rb +1 -1
  163. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies_properties.rb +1 -1
  164. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_telephone_database.rb +1 -1
  165. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_voting_register.rb +1 -1
  166. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth.rb +1 -1
  167. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown.rb +1 -1
  168. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies.rb +1 -1
  169. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_voting_register.rb +1 -1
  170. data/lib/onfido/models/identity_enhanced_breakdown_mortality.rb +1 -1
  171. data/lib/onfido/models/identity_enhanced_breakdown_sources.rb +1 -1
  172. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown.rb +1 -1
  173. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources.rb +1 -1
  174. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources_properties.rb +1 -1
  175. data/lib/onfido/models/identity_enhanced_properties.rb +1 -1
  176. data/lib/onfido/models/identity_enhanced_properties_matched_addresses_inner.rb +1 -1
  177. data/lib/onfido/models/identity_enhanced_report.rb +1 -1
  178. data/lib/onfido/models/india_pan_report.rb +1 -1
  179. data/lib/onfido/models/india_pan_report_all_of_breakdown.rb +1 -1
  180. data/lib/onfido/models/india_pan_report_all_of_breakdown_device.rb +1 -1
  181. data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown.rb +1 -1
  182. data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown_pan_valid.rb +1 -1
  183. data/lib/onfido/models/india_pan_report_all_of_properties.rb +1 -1
  184. data/lib/onfido/models/india_pan_report_all_of_properties_device.rb +1 -1
  185. data/lib/onfido/models/known_faces_breakdown.rb +1 -1
  186. data/lib/onfido/models/known_faces_breakdown_image_integrity.rb +1 -1
  187. data/lib/onfido/models/known_faces_breakdown_previously_seen_faces.rb +1 -1
  188. data/lib/onfido/models/known_faces_properties.rb +1 -1
  189. data/lib/onfido/models/known_faces_properties_matches_inner.rb +1 -1
  190. data/lib/onfido/models/known_faces_report.rb +1 -1
  191. data/lib/onfido/models/live_photo.rb +1 -1
  192. data/lib/onfido/models/live_photo_response.rb +1 -1
  193. data/lib/onfido/models/live_photos_list.rb +1 -1
  194. data/lib/onfido/models/live_video.rb +1 -1
  195. data/lib/onfido/models/live_videos_list.rb +1 -1
  196. data/lib/onfido/models/location.rb +1 -1
  197. data/lib/onfido/models/location_builder.rb +1 -1
  198. data/lib/onfido/models/location_shared.rb +1 -1
  199. data/lib/onfido/models/motion_capture.rb +1 -1
  200. data/lib/onfido/models/motion_captures_list.rb +1 -1
  201. data/lib/onfido/models/photo_auto_reasons.rb +1 -1
  202. data/lib/onfido/models/photo_reasons.rb +1 -1
  203. data/lib/onfido/models/proof_of_address_breakdown.rb +1 -1
  204. data/lib/onfido/models/proof_of_address_breakdown_data_comparison.rb +1 -1
  205. data/lib/onfido/models/proof_of_address_breakdown_data_comparison_breakdown.rb +1 -1
  206. data/lib/onfido/models/proof_of_address_breakdown_document_classification.rb +1 -1
  207. data/lib/onfido/models/proof_of_address_breakdown_document_classification_breakdown.rb +1 -1
  208. data/lib/onfido/models/proof_of_address_breakdown_image_integrity.rb +1 -1
  209. data/lib/onfido/models/proof_of_address_breakdown_image_integrity_breakdown.rb +1 -1
  210. data/lib/onfido/models/proof_of_address_properties.rb +1 -1
  211. data/lib/onfido/models/proof_of_address_report.rb +1 -1
  212. data/lib/onfido/models/repeat_attempts_list.rb +1 -1
  213. data/lib/onfido/models/repeat_attempts_list_repeat_attempts_inner.rb +1 -1
  214. data/lib/onfido/models/report.rb +1 -1
  215. data/lib/onfido/models/report_document.rb +1 -1
  216. data/lib/onfido/models/report_name.rb +1 -1
  217. data/lib/onfido/models/report_result.rb +1 -1
  218. data/lib/onfido/models/report_shared.rb +1 -1
  219. data/lib/onfido/models/report_status.rb +1 -1
  220. data/lib/onfido/models/report_sub_result.rb +1 -1
  221. data/lib/onfido/models/reports_list.rb +1 -1
  222. data/lib/onfido/models/results_feedback.rb +1 -1
  223. data/lib/onfido/models/sdk_token.rb +1 -1
  224. data/lib/onfido/models/sdk_token_builder.rb +1 -1
  225. data/lib/onfido/models/sdk_token_request.rb +1 -1
  226. data/lib/onfido/models/sdk_token_response.rb +1 -1
  227. data/lib/onfido/models/task.rb +1 -1
  228. data/lib/onfido/models/task_item.rb +23 -2
  229. data/lib/onfido/models/timeline_file_reference.rb +1 -1
  230. data/lib/onfido/models/us_driving_licence_breakdown.rb +1 -1
  231. data/lib/onfido/models/us_driving_licence_breakdown_address.rb +1 -1
  232. data/lib/onfido/models/us_driving_licence_breakdown_address_breakdown.rb +1 -1
  233. data/lib/onfido/models/us_driving_licence_breakdown_document.rb +1 -1
  234. data/lib/onfido/models/us_driving_licence_breakdown_document_breakdown.rb +1 -1
  235. data/lib/onfido/models/us_driving_licence_breakdown_personal.rb +1 -1
  236. data/lib/onfido/models/us_driving_licence_breakdown_personal_breakdown.rb +1 -1
  237. data/lib/onfido/models/us_driving_licence_builder.rb +1 -1
  238. data/lib/onfido/models/us_driving_licence_report.rb +1 -1
  239. data/lib/onfido/models/us_driving_licence_shared.rb +1 -1
  240. data/lib/onfido/models/video_reasons.rb +1 -1
  241. data/lib/onfido/models/watchlist_aml_breakdown.rb +1 -1
  242. data/lib/onfido/models/watchlist_aml_breakdown_adverse_media.rb +1 -1
  243. data/lib/onfido/models/watchlist_aml_breakdown_legal_and_regulatory_warnings.rb +1 -1
  244. data/lib/onfido/models/watchlist_aml_breakdown_politically_exposed_person.rb +1 -1
  245. data/lib/onfido/models/watchlist_aml_breakdown_sanction.rb +1 -1
  246. data/lib/onfido/models/watchlist_aml_properties.rb +1 -1
  247. data/lib/onfido/models/watchlist_aml_report.rb +1 -1
  248. data/lib/onfido/models/watchlist_enhanced_breakdown.rb +1 -1
  249. data/lib/onfido/models/watchlist_enhanced_properties.rb +1 -1
  250. data/lib/onfido/models/watchlist_enhanced_properties_records_inner.rb +1 -1
  251. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_address_inner.rb +1 -1
  252. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_alias_inner.rb +1 -1
  253. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_associate_inner.rb +1 -1
  254. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_attribute_inner.rb +1 -1
  255. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner.rb +1 -1
  256. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner_source.rb +1 -1
  257. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_source_inner.rb +1 -1
  258. data/lib/onfido/models/watchlist_enhanced_report.rb +1 -1
  259. data/lib/onfido/models/watchlist_monitor.rb +1 -1
  260. data/lib/onfido/models/watchlist_monitor_builder.rb +1 -1
  261. data/lib/onfido/models/watchlist_monitor_match.rb +1 -1
  262. data/lib/onfido/models/watchlist_monitor_matches_list.rb +1 -1
  263. data/lib/onfido/models/watchlist_monitor_matches_updater.rb +1 -1
  264. data/lib/onfido/models/watchlist_monitor_response.rb +1 -1
  265. data/lib/onfido/models/watchlist_monitor_shared.rb +1 -1
  266. data/lib/onfido/models/watchlist_monitors_list.rb +1 -1
  267. data/lib/onfido/models/watchlist_peps_only_report.rb +1 -1
  268. data/lib/onfido/models/watchlist_sanctions_only_report.rb +1 -1
  269. data/lib/onfido/models/watchlist_standard_breakdown.rb +1 -1
  270. data/lib/onfido/models/watchlist_standard_properties.rb +1 -1
  271. data/lib/onfido/models/watchlist_standard_report.rb +1 -1
  272. data/lib/onfido/models/webhook.rb +1 -1
  273. data/lib/onfido/models/webhook_builder.rb +1 -1
  274. data/lib/onfido/models/webhook_create.rb +1 -1
  275. data/lib/onfido/models/webhook_event.rb +1 -1
  276. data/lib/onfido/models/webhook_event_object_status.rb +58 -0
  277. data/lib/onfido/models/webhook_event_payload.rb +3 -4
  278. data/lib/onfido/models/webhook_event_payload_object.rb +24 -3
  279. data/lib/onfido/models/webhook_event_payload_resource.rb +380 -0
  280. data/lib/onfido/models/webhook_event_resource_type.rb +45 -0
  281. data/lib/onfido/models/webhook_event_type.rb +1 -1
  282. data/lib/onfido/models/webhook_resend.rb +1 -1
  283. data/lib/onfido/models/webhook_response.rb +1 -1
  284. data/lib/onfido/models/webhook_shared.rb +1 -1
  285. data/lib/onfido/models/webhook_update.rb +1 -1
  286. data/lib/onfido/models/webhook_updater.rb +1 -1
  287. data/lib/onfido/models/webhooks_list.rb +1 -1
  288. data/lib/onfido/models/webhooks_resend_item.rb +1 -1
  289. data/lib/onfido/models/workflow_run.rb +6 -16
  290. data/lib/onfido/models/workflow_run_builder.rb +3 -2
  291. data/lib/onfido/models/{workflow_run_response_error.rb → workflow_run_error.rb} +4 -5
  292. data/lib/onfido/models/{workflow_run_shared_link.rb → workflow_run_link.rb} +8 -5
  293. data/lib/onfido/models/workflow_run_request.rb +1 -1
  294. data/lib/onfido/models/workflow_run_response.rb +4 -15
  295. data/lib/onfido/models/workflow_run_shared.rb +3 -2
  296. data/lib/onfido/models/workflow_run_status.rb +47 -0
  297. data/lib/onfido/version.rb +2 -2
  298. data/lib/onfido.rb +11 -6
  299. data/onfido.gemspec +1 -1
  300. data/spec/{webhook_event_verifier_spec.rb → classic_webhook_event_verifier_spec.rb} +4 -4
  301. data/spec/integrations/applicant_spec.rb +5 -1
  302. data/spec/integrations/check_spec.rb +4 -4
  303. data/spec/integrations/document_spec.rb +1 -1
  304. data/spec/integrations/qualified_electronic_signature_spec.rb +1 -1
  305. data/spec/integrations/report_schema_spec.rb +17 -0
  306. data/spec/integrations/workflow_run_spec.rb +3 -3
  307. data/spec/shared_contexts/with_check.rb +1 -0
  308. data/spec/shared_contexts/with_document.rb +1 -1
  309. data/spec/studio_webhook_event_verifier_spec.rb +39 -0
  310. metadata +31 -23
  311. data/lib/onfido/models/consents_builder.rb +0 -205
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 80a6064074cd1701caabe2b1a709b23c64b38063a8b74a857021fe4c924b8f3e
4
- data.tar.gz: b0d29ec09c5009095de47d40159af85a00d774e2ee94ffbfe5eb70a7914800e1
3
+ metadata.gz: 84c97682271bcf86f213850a497db54f4ca3d89574a9306a543decbfd8b5db29
4
+ data.tar.gz: b6f0a08180cfb57ed019b873776f1f723065e050d9c4e5ff512b0aabf8c73dfd
5
5
  SHA512:
6
- metadata.gz: 6bfd5c166e29f1e4a417f667308fae843736d8cc237ad205d265ff7127c39fe500f02aefd60ed4ec071230dfde6427ea931ce5e97fd914c680b8c7a5c7e22ae8
7
- data.tar.gz: 8cad9cd387ff988a6a8aaf23c67f6a5119d224d036d0de37494a895320c9ae7584510a4ffeaba69d5ae73e2b0273c6ba2dc7eda2a354a0bca795fcffc402be26
6
+ metadata.gz: eade09a8e29ab656d8c032e470c81a044f47b791e171b3b610a519ffd8866a22dea53dd9dba5df0c6a75d357299fb47852cd02c2349efece713ea7f812fa2d47
7
+ data.tar.gz: d5e4b6c96bf9c9ef1d189a5f5b14b0f31282fd7fa3178daa75eecb79c962b19940c2d2ffba1d93dde8253330f859dc9857f7c9c6de12d9767f1d683c567c7821
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## v4.0.0 24th October 2024
4
+
5
+ - Release based on Onfido OpenAPI spec version [v4.0.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.0.0):
6
+ - [CAT-1379] Add a few missing properties
7
+ - [CAT-1447] Fix applicant consents
8
+ - [CAT-1379] Fix check creation, remove some deprecated properties and deprecate others
9
+ - Use document-type enum for document upload
10
+ - [CAT-1306] Add webhooks event resource
11
+ - Upgrade OpenAPI generator to v7.9.0 (was v7.6.0)
12
+ - [Migration Guide](MIGRATION.md#upgrading-from-3x-to-4x)
13
+
14
+ ## v3.4.0 20th September 2024
15
+
16
+ - Release based on Onfido OpenAPI spec version [v3.5.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v3.5.0):
17
+ - [CAT-1376] Add record item object definition for watchlist enhanced properties field
18
+
3
19
  ## v3.3.1 22nd August 2024
4
20
 
5
21
  - Release based on Onfido OpenAPI spec version [v3.3.1](https://github.com/onfido/onfido-openapi-spec/releases/tag/v3.3.1):
data/MIGRATION.md ADDED
@@ -0,0 +1,30 @@
1
+ # Migration Guide
2
+
3
+ ## Upgrading from 3.x to 4.x
4
+
5
+ ### Core Resources
6
+
7
+ - Applicants
8
+ - Replace broken `ConsentsBuilder` object with a list of `ApplicantConsentBuilder` ones
9
+ - Workflow Runs
10
+ - Rename `WorkflowRunSharedLink` object into `WorkflowRunLink`
11
+ - Define `WorkflowRunStatus` enum for storing status information
12
+ - Rename `WorkflowRunResponseError` object into `WorkflowRunError`
13
+ - Documents
14
+ - Reuse already existent `DocumentTypes` enum when uploading documents
15
+
16
+ ### Other Endpoints
17
+
18
+ - Webhooks
19
+ - Define `WebhookEventObjectStatus` enum to collect webhook event object's status
20
+ - Define `WebhookEventResourceType` enum to collect webhhok event resource's type
21
+ - Define `WebhookEventPayloadResource` object to store webhook payload's contents
22
+ - Checks
23
+ - Define `CheckStatus` enum for accessing checks status
24
+ - Reports
25
+ - Remove properties from `DeviceIntelligenceBreakdownPropertiesDevice` object: `true_os`, `os_anomaly`, `rooted` and `remote_software`
26
+ - Remove properties from `DeviceIntelligenceBreakdownPropertiesIp` object: `vpn_detection`, `proxy_detection` and `type`
27
+
28
+ ### OpenAPI generator
29
+
30
+ - Version upgraded from 7.6.0 to 7.9.0
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, '~> 3.4.0'
17
+ gem onfido, '~> 4.1.0'
18
18
  ```
19
19
 
20
20
  Configure with your API token, region and optional timeout (default value is 30):
@@ -86,7 +86,7 @@ Webhook events payload needs to be verified before it can be accessed. Library a
86
86
 
87
87
  ## Contributing
88
88
 
89
- This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.6.0); therefore all the contributions, except tests files, should target [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository.
89
+ This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.9.0); therefore all the contributions, except tests files, should target [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository.
90
90
 
91
91
  For contributions to the tests instead, please follow the steps below:
92
92