onfido 3.3.1 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (309) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -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 +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 +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 +1 -1
  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 +2 -2
  250. data/lib/onfido/models/watchlist_enhanced_properties_records_inner.rb +311 -0
  251. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_address_inner.rb +281 -0
  252. data/lib/onfido/models/{consents_builder.rb → watchlist_enhanced_properties_records_inner_alias_inner.rb} +24 -6
  253. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_associate_inner.rb +232 -0
  254. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_attribute_inner.rb +223 -0
  255. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner.rb +250 -0
  256. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner_source.rb +241 -0
  257. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_source_inner.rb +241 -0
  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 +18 -5
  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/workflow_run_spec.rb +3 -3
  306. data/spec/shared_contexts/with_check.rb +1 -0
  307. data/spec/shared_contexts/with_document.rb +1 -1
  308. data/spec/studio_webhook_event_verifier_spec.rb +39 -0
  309. metadata +39 -23
@@ -0,0 +1,250 @@
1
+ =begin
2
+ #Onfido API v3.6
3
+
4
+ #The Onfido API (v3.6)
5
+
6
+ The version of the OpenAPI document: v3.6
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.9.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Onfido
17
+ class WatchlistEnhancedPropertiesRecordsInnerEventInner
18
+ attr_accessor :category
19
+
20
+ attr_accessor :event_date
21
+
22
+ attr_accessor :event_description
23
+
24
+ attr_accessor :source
25
+
26
+ attr_accessor :sub_category
27
+
28
+ # Attribute mapping from ruby-style variable name to JSON key.
29
+ def self.attribute_map
30
+ {
31
+ :'category' => :'category',
32
+ :'event_date' => :'event_date',
33
+ :'event_description' => :'event_description',
34
+ :'source' => :'source',
35
+ :'sub_category' => :'sub_category'
36
+ }
37
+ end
38
+
39
+ # Returns all the JSON keys this model knows about
40
+ def self.acceptable_attributes
41
+ attribute_map.values
42
+ end
43
+
44
+ # Attribute type mapping.
45
+ def self.openapi_types
46
+ {
47
+ :'category' => :'String',
48
+ :'event_date' => :'Date',
49
+ :'event_description' => :'String',
50
+ :'source' => :'WatchlistEnhancedPropertiesRecordsInnerEventInnerSource',
51
+ :'sub_category' => :'String'
52
+ }
53
+ end
54
+
55
+ # List of attributes with nullable: true
56
+ def self.openapi_nullable
57
+ Set.new([
58
+ ])
59
+ end
60
+
61
+ # Initializes the object
62
+ # @param [Hash] attributes Model attributes in the form of hash
63
+ def initialize(attributes = {})
64
+ if (!attributes.is_a?(Hash))
65
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::WatchlistEnhancedPropertiesRecordsInnerEventInner` initialize method"
66
+ end
67
+
68
+ # check to see if the attribute exists and convert string to symbol for hash key
69
+ attributes = attributes.each_with_object({}) { |(k, v), h|
70
+ if (!self.class.attribute_map.key?(k.to_sym))
71
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WatchlistEnhancedPropertiesRecordsInnerEventInner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
72
+ end
73
+ h[k.to_sym] = v
74
+ }
75
+
76
+ if attributes.key?(:'category')
77
+ self.category = attributes[:'category']
78
+ end
79
+
80
+ if attributes.key?(:'event_date')
81
+ self.event_date = attributes[:'event_date']
82
+ end
83
+
84
+ if attributes.key?(:'event_description')
85
+ self.event_description = attributes[:'event_description']
86
+ end
87
+
88
+ if attributes.key?(:'source')
89
+ self.source = attributes[:'source']
90
+ end
91
+
92
+ if attributes.key?(:'sub_category')
93
+ self.sub_category = attributes[:'sub_category']
94
+ end
95
+ end
96
+
97
+ # Show invalid properties with the reasons. Usually used together with valid?
98
+ # @return Array for valid properties with the reasons
99
+ def list_invalid_properties
100
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
101
+ invalid_properties = Array.new
102
+ invalid_properties
103
+ end
104
+
105
+ # Check to see if the all the properties in the model are valid
106
+ # @return true if the model is valid
107
+ def valid?
108
+ warn '[DEPRECATED] the `valid?` method is obsolete'
109
+ true
110
+ end
111
+
112
+ # Checks equality by comparing each attribute.
113
+ # @param [Object] Object to be compared
114
+ def ==(o)
115
+ return true if self.equal?(o)
116
+ self.class == o.class &&
117
+ category == o.category &&
118
+ event_date == o.event_date &&
119
+ event_description == o.event_description &&
120
+ source == o.source &&
121
+ sub_category == o.sub_category
122
+ end
123
+
124
+ # @see the `==` method
125
+ # @param [Object] Object to be compared
126
+ def eql?(o)
127
+ self == o
128
+ end
129
+
130
+ # Calculates hash code according to all attributes.
131
+ # @return [Integer] Hash code
132
+ def hash
133
+ [category, event_date, event_description, source, sub_category].hash
134
+ end
135
+
136
+ # Builds the object from hash
137
+ # @param [Hash] attributes Model attributes in the form of hash
138
+ # @return [Object] Returns the model itself
139
+ def self.build_from_hash(attributes)
140
+ return nil unless attributes.is_a?(Hash)
141
+ attributes = attributes.transform_keys(&:to_sym)
142
+ transformed_hash = {}
143
+ openapi_types.each_pair do |key, type|
144
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
145
+ transformed_hash["#{key}"] = nil
146
+ elsif type =~ /\AArray<(.*)>/i
147
+ # check to ensure the input is an array given that the attribute
148
+ # is documented as an array but the input is not
149
+ if attributes[attribute_map[key]].is_a?(Array)
150
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
151
+ end
152
+ elsif !attributes[attribute_map[key]].nil?
153
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
154
+ end
155
+ end
156
+ new(transformed_hash)
157
+ end
158
+
159
+ # Deserializes the data based on type
160
+ # @param string type Data type
161
+ # @param string value Value to be deserialized
162
+ # @return [Object] Deserialized data
163
+ def self._deserialize(type, value)
164
+ case type.to_sym
165
+ when :Time
166
+ Time.parse(value)
167
+ when :Date
168
+ Date.parse(value)
169
+ when :String
170
+ value.to_s
171
+ when :Integer
172
+ value.to_i
173
+ when :Float
174
+ value.to_f
175
+ when :Boolean
176
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
177
+ true
178
+ else
179
+ false
180
+ end
181
+ when :Object
182
+ # generic object (usually a Hash), return directly
183
+ value
184
+ when /\AArray<(?<inner_type>.+)>\z/
185
+ inner_type = Regexp.last_match[:inner_type]
186
+ value.map { |v| _deserialize(inner_type, v) }
187
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
188
+ k_type = Regexp.last_match[:k_type]
189
+ v_type = Regexp.last_match[:v_type]
190
+ {}.tap do |hash|
191
+ value.each do |k, v|
192
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
193
+ end
194
+ end
195
+ else # model
196
+ # models (e.g. Pet) or oneOf
197
+ klass = Onfido.const_get(type)
198
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
199
+ end
200
+ end
201
+
202
+ # Returns the string representation of the object
203
+ # @return [String] String presentation of the object
204
+ def to_s
205
+ to_hash.to_s
206
+ end
207
+
208
+ # to_body is an alias to to_hash (backward compatibility)
209
+ # @return [Hash] Returns the object in the form of hash
210
+ def to_body
211
+ to_hash
212
+ end
213
+
214
+ # Returns the object in the form of hash
215
+ # @return [Hash] Returns the object in the form of hash
216
+ def to_hash
217
+ hash = {}
218
+ self.class.attribute_map.each_pair do |attr, param|
219
+ value = self.send(attr)
220
+ if value.nil?
221
+ is_nullable = self.class.openapi_nullable.include?(attr)
222
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
223
+ end
224
+
225
+ hash[param] = _to_hash(value)
226
+ end
227
+ hash
228
+ end
229
+
230
+ # Outputs non-array value in the form of hash
231
+ # For object, use to_hash. Otherwise, just return the value
232
+ # @param [Object] value Any valid value
233
+ # @return [Hash] Returns the value in the form of hash
234
+ def _to_hash(value)
235
+ if value.is_a?(Array)
236
+ value.compact.map { |v| _to_hash(v) }
237
+ elsif value.is_a?(Hash)
238
+ {}.tap do |hash|
239
+ value.each { |k, v| hash[k] = _to_hash(v) }
240
+ end
241
+ elsif value.respond_to? :to_hash
242
+ value.to_hash
243
+ else
244
+ value
245
+ end
246
+ end
247
+
248
+ end
249
+
250
+ end
@@ -0,0 +1,241 @@
1
+ =begin
2
+ #Onfido API v3.6
3
+
4
+ #The Onfido API (v3.6)
5
+
6
+ The version of the OpenAPI document: v3.6
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.9.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Onfido
17
+ class WatchlistEnhancedPropertiesRecordsInnerEventInnerSource
18
+ attr_accessor :source_date
19
+
20
+ attr_accessor :source_format
21
+
22
+ attr_accessor :source_name
23
+
24
+ attr_accessor :source_url
25
+
26
+ # Attribute mapping from ruby-style variable name to JSON key.
27
+ def self.attribute_map
28
+ {
29
+ :'source_date' => :'source_date',
30
+ :'source_format' => :'source_format',
31
+ :'source_name' => :'source_name',
32
+ :'source_url' => :'source_url'
33
+ }
34
+ end
35
+
36
+ # Returns all the JSON keys this model knows about
37
+ def self.acceptable_attributes
38
+ attribute_map.values
39
+ end
40
+
41
+ # Attribute type mapping.
42
+ def self.openapi_types
43
+ {
44
+ :'source_date' => :'Date',
45
+ :'source_format' => :'String',
46
+ :'source_name' => :'String',
47
+ :'source_url' => :'String'
48
+ }
49
+ end
50
+
51
+ # List of attributes with nullable: true
52
+ def self.openapi_nullable
53
+ Set.new([
54
+ ])
55
+ end
56
+
57
+ # Initializes the object
58
+ # @param [Hash] attributes Model attributes in the form of hash
59
+ def initialize(attributes = {})
60
+ if (!attributes.is_a?(Hash))
61
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::WatchlistEnhancedPropertiesRecordsInnerEventInnerSource` initialize method"
62
+ end
63
+
64
+ # check to see if the attribute exists and convert string to symbol for hash key
65
+ attributes = attributes.each_with_object({}) { |(k, v), h|
66
+ if (!self.class.attribute_map.key?(k.to_sym))
67
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::WatchlistEnhancedPropertiesRecordsInnerEventInnerSource`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
68
+ end
69
+ h[k.to_sym] = v
70
+ }
71
+
72
+ if attributes.key?(:'source_date')
73
+ self.source_date = attributes[:'source_date']
74
+ end
75
+
76
+ if attributes.key?(:'source_format')
77
+ self.source_format = attributes[:'source_format']
78
+ end
79
+
80
+ if attributes.key?(:'source_name')
81
+ self.source_name = attributes[:'source_name']
82
+ end
83
+
84
+ if attributes.key?(:'source_url')
85
+ self.source_url = attributes[:'source_url']
86
+ end
87
+ end
88
+
89
+ # Show invalid properties with the reasons. Usually used together with valid?
90
+ # @return Array for valid properties with the reasons
91
+ def list_invalid_properties
92
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
93
+ invalid_properties = Array.new
94
+ invalid_properties
95
+ end
96
+
97
+ # Check to see if the all the properties in the model are valid
98
+ # @return true if the model is valid
99
+ def valid?
100
+ warn '[DEPRECATED] the `valid?` method is obsolete'
101
+ true
102
+ end
103
+
104
+ # Checks equality by comparing each attribute.
105
+ # @param [Object] Object to be compared
106
+ def ==(o)
107
+ return true if self.equal?(o)
108
+ self.class == o.class &&
109
+ source_date == o.source_date &&
110
+ source_format == o.source_format &&
111
+ source_name == o.source_name &&
112
+ source_url == o.source_url
113
+ end
114
+
115
+ # @see the `==` method
116
+ # @param [Object] Object to be compared
117
+ def eql?(o)
118
+ self == o
119
+ end
120
+
121
+ # Calculates hash code according to all attributes.
122
+ # @return [Integer] Hash code
123
+ def hash
124
+ [source_date, source_format, source_name, source_url].hash
125
+ end
126
+
127
+ # Builds the object from hash
128
+ # @param [Hash] attributes Model attributes in the form of hash
129
+ # @return [Object] Returns the model itself
130
+ def self.build_from_hash(attributes)
131
+ return nil unless attributes.is_a?(Hash)
132
+ attributes = attributes.transform_keys(&:to_sym)
133
+ transformed_hash = {}
134
+ openapi_types.each_pair do |key, type|
135
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
136
+ transformed_hash["#{key}"] = nil
137
+ elsif type =~ /\AArray<(.*)>/i
138
+ # check to ensure the input is an array given that the attribute
139
+ # is documented as an array but the input is not
140
+ if attributes[attribute_map[key]].is_a?(Array)
141
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
142
+ end
143
+ elsif !attributes[attribute_map[key]].nil?
144
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
145
+ end
146
+ end
147
+ new(transformed_hash)
148
+ end
149
+
150
+ # Deserializes the data based on type
151
+ # @param string type Data type
152
+ # @param string value Value to be deserialized
153
+ # @return [Object] Deserialized data
154
+ def self._deserialize(type, value)
155
+ case type.to_sym
156
+ when :Time
157
+ Time.parse(value)
158
+ when :Date
159
+ Date.parse(value)
160
+ when :String
161
+ value.to_s
162
+ when :Integer
163
+ value.to_i
164
+ when :Float
165
+ value.to_f
166
+ when :Boolean
167
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
168
+ true
169
+ else
170
+ false
171
+ end
172
+ when :Object
173
+ # generic object (usually a Hash), return directly
174
+ value
175
+ when /\AArray<(?<inner_type>.+)>\z/
176
+ inner_type = Regexp.last_match[:inner_type]
177
+ value.map { |v| _deserialize(inner_type, v) }
178
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
179
+ k_type = Regexp.last_match[:k_type]
180
+ v_type = Regexp.last_match[:v_type]
181
+ {}.tap do |hash|
182
+ value.each do |k, v|
183
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
184
+ end
185
+ end
186
+ else # model
187
+ # models (e.g. Pet) or oneOf
188
+ klass = Onfido.const_get(type)
189
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
190
+ end
191
+ end
192
+
193
+ # Returns the string representation of the object
194
+ # @return [String] String presentation of the object
195
+ def to_s
196
+ to_hash.to_s
197
+ end
198
+
199
+ # to_body is an alias to to_hash (backward compatibility)
200
+ # @return [Hash] Returns the object in the form of hash
201
+ def to_body
202
+ to_hash
203
+ end
204
+
205
+ # Returns the object in the form of hash
206
+ # @return [Hash] Returns the object in the form of hash
207
+ def to_hash
208
+ hash = {}
209
+ self.class.attribute_map.each_pair do |attr, param|
210
+ value = self.send(attr)
211
+ if value.nil?
212
+ is_nullable = self.class.openapi_nullable.include?(attr)
213
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
214
+ end
215
+
216
+ hash[param] = _to_hash(value)
217
+ end
218
+ hash
219
+ end
220
+
221
+ # Outputs non-array value in the form of hash
222
+ # For object, use to_hash. Otherwise, just return the value
223
+ # @param [Object] value Any valid value
224
+ # @return [Hash] Returns the value in the form of hash
225
+ def _to_hash(value)
226
+ if value.is_a?(Array)
227
+ value.compact.map { |v| _to_hash(v) }
228
+ elsif value.is_a?(Hash)
229
+ {}.tap do |hash|
230
+ value.each { |k, v| hash[k] = _to_hash(v) }
231
+ end
232
+ elsif value.respond_to? :to_hash
233
+ value.to_hash
234
+ else
235
+ value
236
+ end
237
+ end
238
+
239
+ end
240
+
241
+ end