onfido 5.6.0 → 6.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 (324) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -0
  3. data/MIGRATION.md +28 -0
  4. data/README.md +2 -2
  5. data/lib/onfido/api/default_api.rb +689 -5
  6. data/lib/onfido/api_client.rb +2 -2
  7. data/lib/onfido/api_error.rb +1 -1
  8. data/lib/onfido/configuration.rb +1 -2
  9. data/lib/onfido/models/address.rb +30 -4
  10. data/lib/onfido/models/address_builder.rb +30 -4
  11. data/lib/onfido/models/address_shared.rb +30 -4
  12. data/lib/onfido/models/addresses_list.rb +10 -4
  13. data/lib/onfido/models/applicant.rb +20 -4
  14. data/lib/onfido/models/applicant_builder.rb +10 -4
  15. data/lib/onfido/models/applicant_consent.rb +30 -4
  16. data/lib/onfido/models/applicant_consent_builder.rb +30 -4
  17. data/lib/onfido/models/applicant_consent_name.rb +1 -1
  18. data/lib/onfido/models/applicant_create.rb +10 -4
  19. data/lib/onfido/models/applicant_request.rb +10 -4
  20. data/lib/onfido/models/applicant_response.rb +20 -4
  21. data/lib/onfido/models/applicant_shared.rb +10 -4
  22. data/lib/onfido/models/applicant_update.rb +10 -4
  23. data/lib/onfido/models/applicant_updater.rb +10 -4
  24. data/lib/onfido/models/applicants_list.rb +20 -4
  25. data/lib/onfido/models/check.rb +30 -4
  26. data/lib/onfido/models/check_builder.rb +30 -4
  27. data/lib/onfido/models/check_request.rb +20 -4
  28. data/lib/onfido/models/check_response.rb +20 -4
  29. data/lib/onfido/models/check_shared.rb +20 -4
  30. data/lib/onfido/models/check_status.rb +1 -1
  31. data/lib/onfido/models/checks_list.rb +20 -4
  32. data/lib/onfido/models/complete_task_builder.rb +20 -4
  33. data/lib/onfido/models/complete_task_data_builder.rb +3 -4
  34. data/lib/onfido/models/country_codes.rb +1 -1
  35. data/lib/onfido/models/device_intelligence_breakdown.rb +14 -26
  36. data/lib/onfido/models/device_intelligence_breakdown_device.rb +10 -4
  37. data/lib/onfido/models/device_intelligence_breakdown_device_breakdown.rb +10 -4
  38. data/lib/onfido/models/device_intelligence_properties.rb +13 -7
  39. data/lib/onfido/models/{device_intelligence_breakdown_properties_device.rb → device_intelligence_properties_device.rb} +12 -6
  40. data/lib/onfido/models/{device_intelligence_breakdown_properties_geolocation.rb → device_intelligence_properties_geolocation.rb} +12 -6
  41. data/lib/onfido/models/{device_intelligence_breakdown_properties_ip.rb → device_intelligence_properties_ip.rb} +12 -6
  42. data/lib/onfido/models/device_intelligence_report.rb +30 -4
  43. data/lib/onfido/models/document.rb +20 -4
  44. data/lib/onfido/models/document_breakdown.rb +10 -4
  45. data/lib/onfido/models/document_breakdown_age_validation.rb +10 -4
  46. data/lib/onfido/models/document_breakdown_age_validation_breakdown.rb +10 -4
  47. data/lib/onfido/models/document_breakdown_compromised_document.rb +10 -4
  48. data/lib/onfido/models/document_breakdown_compromised_document_breakdown.rb +10 -4
  49. data/lib/onfido/models/document_breakdown_data_comparison.rb +10 -4
  50. data/lib/onfido/models/document_breakdown_data_comparison_breakdown.rb +10 -4
  51. data/lib/onfido/models/document_breakdown_data_comparison_breakdown_issuing_country.rb +10 -4
  52. data/lib/onfido/models/document_breakdown_data_consistency.rb +10 -4
  53. data/lib/onfido/models/document_breakdown_data_consistency_breakdown.rb +10 -4
  54. data/lib/onfido/models/document_breakdown_data_validation.rb +10 -4
  55. data/lib/onfido/models/document_breakdown_data_validation_breakdown.rb +10 -4
  56. data/lib/onfido/models/document_breakdown_data_validation_breakdown_document_expiration.rb +10 -4
  57. data/lib/onfido/models/document_breakdown_data_validation_breakdown_expiry_date.rb +10 -4
  58. data/lib/onfido/models/document_breakdown_image_integrity.rb +10 -4
  59. data/lib/onfido/models/document_breakdown_image_integrity_breakdown.rb +10 -4
  60. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_colour_picture.rb +10 -4
  61. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_conclusive_document_quality.rb +10 -4
  62. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_image_quality.rb +10 -4
  63. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_supported_document.rb +10 -4
  64. data/lib/onfido/models/document_breakdown_issuing_authority.rb +10 -4
  65. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown.rb +10 -4
  66. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_active_authentication.rb +10 -4
  67. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_passive_authentication.rb +10 -4
  68. data/lib/onfido/models/document_breakdown_police_record.rb +10 -4
  69. data/lib/onfido/models/document_breakdown_visual_authenticity.rb +10 -4
  70. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown.rb +10 -4
  71. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_digital_tampering.rb +10 -4
  72. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_face_detection.rb +10 -4
  73. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_fonts.rb +10 -4
  74. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_original_document_present.rb +10 -4
  75. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_other.rb +10 -4
  76. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_picture_face_integrity.rb +10 -4
  77. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_security_features.rb +10 -4
  78. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_template.rb +10 -4
  79. data/lib/onfido/models/document_cdq_reasons.rb +10 -4
  80. data/lib/onfido/models/document_iq_reasons.rb +10 -4
  81. data/lib/onfido/models/document_odp_reasons.rb +10 -4
  82. data/lib/onfido/models/document_properties.rb +20 -16
  83. data/lib/onfido/models/document_properties_address_lines.rb +10 -4
  84. data/lib/onfido/models/document_properties_barcode_inner.rb +10 -4
  85. data/lib/onfido/models/document_properties_document_classification.rb +10 -4
  86. data/lib/onfido/models/document_properties_document_numbers_inner.rb +10 -4
  87. data/lib/onfido/models/document_properties_driving_licence_information_item.rb +10 -4
  88. data/lib/onfido/models/document_properties_extracted_data.rb +10 -4
  89. data/lib/onfido/models/document_properties_nfc.rb +10 -4
  90. data/lib/onfido/models/document_properties_with_driving_licence_information.rb +697 -0
  91. data/lib/onfido/models/document_report.rb +30 -4
  92. data/lib/onfido/models/document_report_shared.rb +10 -4
  93. data/lib/onfido/models/document_response.rb +20 -4
  94. data/lib/onfido/models/document_shared.rb +10 -4
  95. data/lib/onfido/models/document_types.rb +1 -1
  96. data/lib/onfido/models/document_video_report.rb +30 -4
  97. data/lib/onfido/models/document_video_with_address_information_report.rb +30 -4
  98. data/lib/onfido/models/document_with_address_information_report.rb +30 -4
  99. data/lib/onfido/models/document_with_driver_verification_report.rb +30 -4
  100. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb +20 -16
  101. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle.rb +10 -4
  102. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner.rb +10 -4
  103. data/lib/onfido/models/document_with_driving_licence_information_report.rb +31 -5
  104. data/lib/onfido/models/documents_list.rb +20 -4
  105. data/lib/onfido/models/error.rb +10 -4
  106. data/lib/onfido/models/error1.rb +10 -4
  107. data/lib/onfido/models/error_properties.rb +10 -4
  108. data/lib/onfido/models/error_properties1.rb +10 -4
  109. data/lib/onfido/models/extract_request.rb +20 -4
  110. data/lib/onfido/models/extraction.rb +10 -4
  111. data/lib/onfido/models/extraction_document_classification.rb +10 -4
  112. data/lib/onfido/models/extraction_extracted_data.rb +10 -4
  113. data/lib/onfido/models/facial_similarity_motion_breakdown.rb +10 -4
  114. data/lib/onfido/models/facial_similarity_motion_breakdown_face_comparison.rb +10 -4
  115. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity.rb +10 -4
  116. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown.rb +10 -4
  117. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_face_detected.rb +10 -4
  118. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_source_integrity.rb +10 -4
  119. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity.rb +10 -4
  120. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown.rb +10 -4
  121. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +10 -4
  122. data/lib/onfido/models/facial_similarity_motion_properties.rb +10 -4
  123. data/lib/onfido/models/facial_similarity_motion_report.rb +30 -4
  124. data/lib/onfido/models/facial_similarity_photo_breakdown.rb +10 -4
  125. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison.rb +10 -4
  126. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown.rb +10 -4
  127. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match.rb +10 -4
  128. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match_properties.rb +10 -4
  129. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity.rb +10 -4
  130. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown.rb +10 -4
  131. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_face_detected.rb +10 -4
  132. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_source_integrity.rb +10 -4
  133. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity.rb +10 -4
  134. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown.rb +10 -4
  135. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +10 -4
  136. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection_properties.rb +10 -4
  137. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown.rb +10 -4
  138. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity.rb +10 -4
  139. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown.rb +10 -4
  140. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity.rb +10 -4
  141. data/lib/onfido/models/facial_similarity_photo_fully_auto_properties.rb +10 -4
  142. data/lib/onfido/models/facial_similarity_photo_fully_auto_report.rb +30 -4
  143. data/lib/onfido/models/facial_similarity_photo_properties.rb +10 -4
  144. data/lib/onfido/models/facial_similarity_photo_report.rb +30 -4
  145. data/lib/onfido/models/facial_similarity_report_media.rb +20 -4
  146. data/lib/onfido/models/facial_similarity_report_shared.rb +10 -4
  147. data/lib/onfido/models/facial_similarity_video_breakdown.rb +10 -4
  148. data/lib/onfido/models/facial_similarity_video_breakdown_face_comparison.rb +10 -4
  149. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity.rb +10 -4
  150. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown.rb +10 -4
  151. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected.rb +10 -4
  152. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity.rb +10 -4
  153. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity.rb +10 -4
  154. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown.rb +10 -4
  155. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected.rb +10 -4
  156. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +10 -4
  157. data/lib/onfido/models/facial_similarity_video_properties.rb +10 -4
  158. data/lib/onfido/models/facial_similarity_video_report.rb +30 -4
  159. data/lib/onfido/models/id_number.rb +10 -4
  160. data/lib/onfido/models/id_photo.rb +20 -4
  161. data/lib/onfido/models/id_photo_response.rb +20 -4
  162. data/lib/onfido/models/id_photos_list.rb +20 -4
  163. data/lib/onfido/models/identity_enhanced_breakdown.rb +10 -4
  164. data/lib/onfido/models/identity_enhanced_breakdown_address.rb +10 -4
  165. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown.rb +10 -4
  166. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies.rb +10 -4
  167. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies_properties.rb +11 -5
  168. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_telephone_database.rb +10 -4
  169. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_voting_register.rb +10 -4
  170. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth.rb +10 -4
  171. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown.rb +10 -4
  172. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies.rb +10 -4
  173. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_voting_register.rb +10 -4
  174. data/lib/onfido/models/identity_enhanced_breakdown_mortality.rb +10 -4
  175. data/lib/onfido/models/identity_enhanced_breakdown_sources.rb +10 -4
  176. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown.rb +10 -4
  177. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources.rb +10 -4
  178. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources_properties.rb +11 -5
  179. data/lib/onfido/models/identity_enhanced_properties.rb +10 -4
  180. data/lib/onfido/models/identity_enhanced_properties_matched_addresses_inner.rb +10 -4
  181. data/lib/onfido/models/identity_enhanced_report.rb +30 -4
  182. data/lib/onfido/models/idr_ssn_breakdown.rb +10 -4
  183. data/lib/onfido/models/idr_ssn_breakdown_breakdown.rb +10 -4
  184. data/lib/onfido/models/idr_ssn_breakdown_breakdown_full_match.rb +10 -4
  185. data/lib/onfido/models/idr_ssn_breakdown_breakdown_last4_digits_match.rb +10 -4
  186. data/lib/onfido/models/india_pan_report.rb +30 -4
  187. data/lib/onfido/models/india_pan_report_all_of_breakdown.rb +10 -4
  188. data/lib/onfido/models/india_pan_report_all_of_breakdown_device.rb +10 -4
  189. data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown.rb +10 -4
  190. data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown_pan_valid.rb +10 -4
  191. data/lib/onfido/models/india_pan_report_all_of_properties.rb +10 -4
  192. data/lib/onfido/models/india_pan_report_all_of_properties_device.rb +10 -4
  193. data/lib/onfido/models/known_faces_breakdown.rb +10 -4
  194. data/lib/onfido/models/known_faces_breakdown_image_integrity.rb +10 -4
  195. data/lib/onfido/models/known_faces_breakdown_previously_seen_faces.rb +10 -4
  196. data/lib/onfido/models/known_faces_properties.rb +10 -4
  197. data/lib/onfido/models/known_faces_properties_matches_inner.rb +10 -4
  198. data/lib/onfido/models/known_faces_report.rb +30 -4
  199. data/lib/onfido/models/live_photo.rb +20 -4
  200. data/lib/onfido/models/live_photo_response.rb +20 -4
  201. data/lib/onfido/models/live_photos_list.rb +20 -4
  202. data/lib/onfido/models/live_video.rb +10 -4
  203. data/lib/onfido/models/live_videos_list.rb +20 -4
  204. data/lib/onfido/models/location.rb +10 -4
  205. data/lib/onfido/models/location_builder.rb +10 -4
  206. data/lib/onfido/models/location_shared.rb +10 -4
  207. data/lib/onfido/models/motion_capture.rb +10 -4
  208. data/lib/onfido/models/motion_captures_list.rb +20 -4
  209. data/lib/onfido/models/passkey.rb +353 -0
  210. data/lib/onfido/models/passkey_updater.rb +262 -0
  211. data/lib/onfido/models/{device_intelligence_breakdown_properties.rb → passkeys_list.rb} +38 -31
  212. data/lib/onfido/models/photo_auto_reasons.rb +10 -4
  213. data/lib/onfido/models/photo_reasons.rb +10 -4
  214. data/lib/onfido/models/proof_of_address_breakdown.rb +10 -4
  215. data/lib/onfido/models/proof_of_address_breakdown_data_comparison.rb +10 -4
  216. data/lib/onfido/models/proof_of_address_breakdown_data_comparison_breakdown.rb +10 -4
  217. data/lib/onfido/models/proof_of_address_breakdown_document_classification.rb +10 -4
  218. data/lib/onfido/models/proof_of_address_breakdown_document_classification_breakdown.rb +10 -4
  219. data/lib/onfido/models/proof_of_address_breakdown_image_integrity.rb +10 -4
  220. data/lib/onfido/models/proof_of_address_breakdown_image_integrity_breakdown.rb +10 -4
  221. data/lib/onfido/models/proof_of_address_properties.rb +10 -4
  222. data/lib/onfido/models/proof_of_address_report.rb +30 -4
  223. data/lib/onfido/models/repeat_attempts_list.rb +20 -4
  224. data/lib/onfido/models/repeat_attempts_list_repeat_attempts_inner.rb +10 -4
  225. data/lib/onfido/models/report.rb +1 -1
  226. data/lib/onfido/models/report_configuration.rb +10 -4
  227. data/lib/onfido/models/report_configuration_facial_similarity.rb +10 -4
  228. data/lib/onfido/models/report_document.rb +20 -4
  229. data/lib/onfido/models/report_name.rb +1 -1
  230. data/lib/onfido/models/report_result.rb +1 -1
  231. data/lib/onfido/models/report_shared.rb +30 -4
  232. data/lib/onfido/models/report_status.rb +1 -1
  233. data/lib/onfido/models/report_sub_result.rb +1 -1
  234. data/lib/onfido/models/reports_list.rb +20 -4
  235. data/lib/onfido/models/results_feedback.rb +10 -4
  236. data/lib/onfido/models/sdk_token.rb +20 -4
  237. data/lib/onfido/models/sdk_token_builder.rb +20 -4
  238. data/lib/onfido/models/sdk_token_request.rb +20 -4
  239. data/lib/onfido/models/sdk_token_response.rb +20 -4
  240. data/lib/onfido/models/signing_document.rb +316 -0
  241. data/lib/onfido/models/signing_document_response.rb +298 -0
  242. data/lib/onfido/models/{device_intelligence_breakdown_breakdown.rb → signing_document_shared.rb} +20 -13
  243. data/lib/onfido/models/signing_documents_list.rb +239 -0
  244. data/lib/onfido/models/task.rb +10 -4
  245. data/lib/onfido/models/task_item.rb +10 -4
  246. data/lib/onfido/models/timeline_file_reference.rb +30 -4
  247. data/lib/onfido/models/us_driving_licence_breakdown.rb +10 -4
  248. data/lib/onfido/models/us_driving_licence_breakdown_address.rb +10 -4
  249. data/lib/onfido/models/us_driving_licence_breakdown_address_breakdown.rb +10 -4
  250. data/lib/onfido/models/us_driving_licence_breakdown_document.rb +10 -4
  251. data/lib/onfido/models/us_driving_licence_breakdown_document_breakdown.rb +10 -4
  252. data/lib/onfido/models/us_driving_licence_breakdown_personal.rb +10 -4
  253. data/lib/onfido/models/us_driving_licence_breakdown_personal_breakdown.rb +10 -4
  254. data/lib/onfido/models/us_driving_licence_builder.rb +20 -4
  255. data/lib/onfido/models/us_driving_licence_report.rb +30 -4
  256. data/lib/onfido/models/us_driving_licence_shared.rb +20 -4
  257. data/lib/onfido/models/video_reasons.rb +10 -4
  258. data/lib/onfido/models/watchlist_aml_breakdown.rb +10 -4
  259. data/lib/onfido/models/watchlist_aml_breakdown_adverse_media.rb +10 -4
  260. data/lib/onfido/models/watchlist_aml_breakdown_legal_and_regulatory_warnings.rb +10 -4
  261. data/lib/onfido/models/watchlist_aml_breakdown_politically_exposed_person.rb +10 -4
  262. data/lib/onfido/models/watchlist_aml_breakdown_sanction.rb +10 -4
  263. data/lib/onfido/models/watchlist_aml_properties.rb +10 -4
  264. data/lib/onfido/models/watchlist_aml_report.rb +30 -4
  265. data/lib/onfido/models/watchlist_enhanced_breakdown.rb +10 -4
  266. data/lib/onfido/models/watchlist_enhanced_properties.rb +10 -4
  267. data/lib/onfido/models/watchlist_enhanced_properties_records_inner.rb +10 -4
  268. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_address_inner.rb +10 -4
  269. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_alias_inner.rb +10 -4
  270. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_associate_inner.rb +10 -4
  271. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_attribute_inner.rb +10 -4
  272. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner.rb +10 -4
  273. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner_source.rb +10 -4
  274. data/lib/onfido/models/watchlist_enhanced_properties_records_inner_source_inner.rb +10 -4
  275. data/lib/onfido/models/watchlist_enhanced_report.rb +30 -4
  276. data/lib/onfido/models/watchlist_monitor.rb +30 -4
  277. data/lib/onfido/models/watchlist_monitor_builder.rb +20 -4
  278. data/lib/onfido/models/watchlist_monitor_match.rb +10 -4
  279. data/lib/onfido/models/watchlist_monitor_matches_list.rb +20 -4
  280. data/lib/onfido/models/watchlist_monitor_matches_updater.rb +10 -4
  281. data/lib/onfido/models/watchlist_monitor_response.rb +20 -4
  282. data/lib/onfido/models/watchlist_monitor_shared.rb +20 -4
  283. data/lib/onfido/models/watchlist_monitors_list.rb +20 -4
  284. data/lib/onfido/models/watchlist_peps_only_report.rb +30 -4
  285. data/lib/onfido/models/watchlist_sanctions_only_report.rb +30 -4
  286. data/lib/onfido/models/watchlist_standard_breakdown.rb +10 -4
  287. data/lib/onfido/models/watchlist_standard_properties.rb +10 -4
  288. data/lib/onfido/models/watchlist_standard_report.rb +30 -4
  289. data/lib/onfido/models/webhook.rb +20 -4
  290. data/lib/onfido/models/webhook_builder.rb +20 -4
  291. data/lib/onfido/models/webhook_create.rb +20 -4
  292. data/lib/onfido/models/webhook_event.rb +10 -4
  293. data/lib/onfido/models/webhook_event_object_status.rb +1 -1
  294. data/lib/onfido/models/webhook_event_payload.rb +20 -4
  295. data/lib/onfido/models/webhook_event_payload_object.rb +20 -4
  296. data/lib/onfido/models/webhook_event_payload_resource.rb +54 -5
  297. data/lib/onfido/models/webhook_event_resource_status.rb +50 -0
  298. data/lib/onfido/models/webhook_event_resource_type.rb +1 -1
  299. data/lib/onfido/models/webhook_event_type.rb +1 -1
  300. data/lib/onfido/models/webhook_resend.rb +10 -4
  301. data/lib/onfido/models/webhook_response.rb +20 -4
  302. data/lib/onfido/models/webhook_shared.rb +10 -4
  303. data/lib/onfido/models/webhook_update.rb +10 -4
  304. data/lib/onfido/models/webhook_updater.rb +10 -4
  305. data/lib/onfido/models/webhooks_list.rb +20 -4
  306. data/lib/onfido/models/webhooks_resend_item.rb +30 -4
  307. data/lib/onfido/models/workflow_run.rb +40 -4
  308. data/lib/onfido/models/workflow_run_builder.rb +30 -4
  309. data/lib/onfido/models/workflow_run_error.rb +10 -4
  310. data/lib/onfido/models/workflow_run_link.rb +10 -4
  311. data/lib/onfido/models/workflow_run_request.rb +10 -4
  312. data/lib/onfido/models/workflow_run_response.rb +20 -4
  313. data/lib/onfido/models/workflow_run_shared.rb +30 -4
  314. data/lib/onfido/models/workflow_run_status.rb +1 -1
  315. data/lib/onfido/version.rb +2 -2
  316. data/lib/onfido.rb +13 -6
  317. data/onfido.gemspec +1 -1
  318. data/spec/integrations/media/sample_signing_document.pdf +33 -0
  319. data/spec/integrations/passkey_spec.rb +63 -0
  320. data/spec/integrations/signing_document_spec.rb +61 -0
  321. data/spec/integrations/workflow_run_spec.rb +7 -3
  322. data/spec/shared_contexts/with_signing_document.rb +15 -0
  323. data/spec/spec_helper.rb +1 -1
  324. metadata +41 -26
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: v3.6
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.11.0
9
+ Generator version: 7.16.0
10
10
 
11
11
  =end
12
12
 
@@ -628,6 +628,138 @@ module Onfido
628
628
  return data, status_code, headers
629
629
  end
630
630
 
631
+ # Delete passkey
632
+ # Deletes a passkey.
633
+ # @param username [String] Username that owns the passkey.
634
+ # @param passkey_id [String] Passkey ID.
635
+ # @param [Hash] opts the optional parameters
636
+ # @return [nil]
637
+ def delete_passkey(username, passkey_id, opts = {})
638
+ delete_passkey_with_http_info(username, passkey_id, opts)
639
+ nil
640
+ end
641
+
642
+ # Delete passkey
643
+ # Deletes a passkey.
644
+ # @param username [String] Username that owns the passkey.
645
+ # @param passkey_id [String] Passkey ID.
646
+ # @param [Hash] opts the optional parameters
647
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
648
+ def delete_passkey_with_http_info(username, passkey_id, opts = {})
649
+ if @api_client.config.debugging
650
+ @api_client.config.logger.debug 'Calling API: DefaultApi.delete_passkey ...'
651
+ end
652
+ # verify the required parameter 'username' is set
653
+ if @api_client.config.client_side_validation && username.nil?
654
+ fail ArgumentError, "Missing the required parameter 'username' when calling DefaultApi.delete_passkey"
655
+ end
656
+ # verify the required parameter 'passkey_id' is set
657
+ if @api_client.config.client_side_validation && passkey_id.nil?
658
+ fail ArgumentError, "Missing the required parameter 'passkey_id' when calling DefaultApi.delete_passkey"
659
+ end
660
+ # resource path
661
+ local_var_path = '/passkeys/{username}/{passkey_id}'.sub('{' + 'username' + '}', CGI.escape(username.to_s)).sub('{' + 'passkey_id' + '}', CGI.escape(passkey_id.to_s))
662
+
663
+ # query parameters
664
+ query_params = opts[:query_params] || {}
665
+
666
+ # header parameters
667
+ header_params = opts[:header_params] || {}
668
+ # HTTP header 'Accept' (if needed)
669
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
670
+
671
+ # form parameters
672
+ form_params = opts[:form_params] || {}
673
+
674
+ # http body (model)
675
+ post_body = opts[:debug_body]
676
+
677
+ # return_type
678
+ return_type = opts[:debug_return_type]
679
+
680
+ # auth_names
681
+ auth_names = opts[:debug_auth_names] || ['Token']
682
+
683
+ new_options = opts.merge(
684
+ :operation => :"DefaultApi.delete_passkey",
685
+ :header_params => header_params,
686
+ :query_params => query_params,
687
+ :form_params => form_params,
688
+ :body => post_body,
689
+ :auth_names => auth_names,
690
+ :return_type => return_type
691
+ )
692
+
693
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
694
+ if @api_client.config.debugging
695
+ @api_client.config.logger.debug "API called: DefaultApi#delete_passkey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
696
+ end
697
+ return data, status_code, headers
698
+ end
699
+
700
+ # Delete passkeys
701
+ # Removes every passkey for the username.
702
+ # @param username [String] Username whose passkeys will be deleted.
703
+ # @param [Hash] opts the optional parameters
704
+ # @return [nil]
705
+ def delete_passkeys(username, opts = {})
706
+ delete_passkeys_with_http_info(username, opts)
707
+ nil
708
+ end
709
+
710
+ # Delete passkeys
711
+ # Removes every passkey for the username.
712
+ # @param username [String] Username whose passkeys will be deleted.
713
+ # @param [Hash] opts the optional parameters
714
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
715
+ def delete_passkeys_with_http_info(username, opts = {})
716
+ if @api_client.config.debugging
717
+ @api_client.config.logger.debug 'Calling API: DefaultApi.delete_passkeys ...'
718
+ end
719
+ # verify the required parameter 'username' is set
720
+ if @api_client.config.client_side_validation && username.nil?
721
+ fail ArgumentError, "Missing the required parameter 'username' when calling DefaultApi.delete_passkeys"
722
+ end
723
+ # resource path
724
+ local_var_path = '/passkeys/{username}'.sub('{' + 'username' + '}', CGI.escape(username.to_s))
725
+
726
+ # query parameters
727
+ query_params = opts[:query_params] || {}
728
+
729
+ # header parameters
730
+ header_params = opts[:header_params] || {}
731
+ # HTTP header 'Accept' (if needed)
732
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
733
+
734
+ # form parameters
735
+ form_params = opts[:form_params] || {}
736
+
737
+ # http body (model)
738
+ post_body = opts[:debug_body]
739
+
740
+ # return_type
741
+ return_type = opts[:debug_return_type]
742
+
743
+ # auth_names
744
+ auth_names = opts[:debug_auth_names] || ['Token']
745
+
746
+ new_options = opts.merge(
747
+ :operation => :"DefaultApi.delete_passkeys",
748
+ :header_params => header_params,
749
+ :query_params => query_params,
750
+ :form_params => form_params,
751
+ :body => post_body,
752
+ :auth_names => auth_names,
753
+ :return_type => return_type
754
+ )
755
+
756
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
757
+ if @api_client.config.debugging
758
+ @api_client.config.logger.debug "API called: DefaultApi#delete_passkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
759
+ end
760
+ return data, status_code, headers
761
+ end
762
+
631
763
  # Delete monitor
632
764
  # Deactivates the given monitor
633
765
  # @param monitor_id [String]
@@ -1589,6 +1721,77 @@ module Onfido
1589
1721
  return data, status_code, headers
1590
1722
  end
1591
1723
 
1724
+ # Retrieves the signed document or signing transaction receipt
1725
+ # Retrieves the signed document or signing transaction receipt depending on the id provided.
1726
+ # @param workflow_run_id [String] The unique identifier of the Workflow Run for which you want to retrieve the signed document.
1727
+ # @param id [String] The unique identifier of the file which you want to retrieve.
1728
+ # @param [Hash] opts the optional parameters
1729
+ # @return [File]
1730
+ def download_ses_document(workflow_run_id, id, opts = {})
1731
+ data, _status_code, _headers = download_ses_document_with_http_info(workflow_run_id, id, opts)
1732
+ data
1733
+ end
1734
+
1735
+ # Retrieves the signed document or signing transaction receipt
1736
+ # Retrieves the signed document or signing transaction receipt depending on the id provided.
1737
+ # @param workflow_run_id [String] The unique identifier of the Workflow Run for which you want to retrieve the signed document.
1738
+ # @param id [String] The unique identifier of the file which you want to retrieve.
1739
+ # @param [Hash] opts the optional parameters
1740
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
1741
+ def download_ses_document_with_http_info(workflow_run_id, id, opts = {})
1742
+ if @api_client.config.debugging
1743
+ @api_client.config.logger.debug 'Calling API: DefaultApi.download_ses_document ...'
1744
+ end
1745
+ # verify the required parameter 'workflow_run_id' is set
1746
+ if @api_client.config.client_side_validation && workflow_run_id.nil?
1747
+ fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.download_ses_document"
1748
+ end
1749
+ # verify the required parameter 'id' is set
1750
+ if @api_client.config.client_side_validation && id.nil?
1751
+ fail ArgumentError, "Missing the required parameter 'id' when calling DefaultApi.download_ses_document"
1752
+ end
1753
+ # resource path
1754
+ local_var_path = '/simple_electronic_signature/documents'
1755
+
1756
+ # query parameters
1757
+ query_params = opts[:query_params] || {}
1758
+ query_params[:'workflow_run_id'] = workflow_run_id
1759
+ query_params[:'id'] = id
1760
+
1761
+ # header parameters
1762
+ header_params = opts[:header_params] || {}
1763
+ # HTTP header 'Accept' (if needed)
1764
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json']) unless header_params['Accept']
1765
+
1766
+ # form parameters
1767
+ form_params = opts[:form_params] || {}
1768
+
1769
+ # http body (model)
1770
+ post_body = opts[:debug_body]
1771
+
1772
+ # return_type
1773
+ return_type = opts[:debug_return_type] || 'File'
1774
+
1775
+ # auth_names
1776
+ auth_names = opts[:debug_auth_names] || ['Token']
1777
+
1778
+ new_options = opts.merge(
1779
+ :operation => :"DefaultApi.download_ses_document",
1780
+ :header_params => header_params,
1781
+ :query_params => query_params,
1782
+ :form_params => form_params,
1783
+ :body => post_body,
1784
+ :auth_names => auth_names,
1785
+ :return_type => return_type
1786
+ )
1787
+
1788
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1789
+ if @api_client.config.debugging
1790
+ @api_client.config.logger.debug "API called: DefaultApi#download_ses_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1791
+ end
1792
+ return data, status_code, headers
1793
+ end
1794
+
1592
1795
  # Retrieve Workflow Run Evidence Summary File
1593
1796
  # Retrieves the signed evidence file for the designated Workflow Run
1594
1797
  # @param workflow_run_id [String] Workflow Run ID
@@ -1652,6 +1855,69 @@ module Onfido
1652
1855
  return data, status_code, headers
1653
1856
  end
1654
1857
 
1858
+ # Download signing document
1859
+ # Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
1860
+ # @param signing_document_id [String]
1861
+ # @param [Hash] opts the optional parameters
1862
+ # @return [File]
1863
+ def download_signing_document(signing_document_id, opts = {})
1864
+ data, _status_code, _headers = download_signing_document_with_http_info(signing_document_id, opts)
1865
+ data
1866
+ end
1867
+
1868
+ # Download signing document
1869
+ # Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
1870
+ # @param signing_document_id [String]
1871
+ # @param [Hash] opts the optional parameters
1872
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
1873
+ def download_signing_document_with_http_info(signing_document_id, opts = {})
1874
+ if @api_client.config.debugging
1875
+ @api_client.config.logger.debug 'Calling API: DefaultApi.download_signing_document ...'
1876
+ end
1877
+ # verify the required parameter 'signing_document_id' is set
1878
+ if @api_client.config.client_side_validation && signing_document_id.nil?
1879
+ fail ArgumentError, "Missing the required parameter 'signing_document_id' when calling DefaultApi.download_signing_document"
1880
+ end
1881
+ # resource path
1882
+ local_var_path = '/signing_documents/{signing_document_id}/download'.sub('{' + 'signing_document_id' + '}', CGI.escape(signing_document_id.to_s))
1883
+
1884
+ # query parameters
1885
+ query_params = opts[:query_params] || {}
1886
+
1887
+ # header parameters
1888
+ header_params = opts[:header_params] || {}
1889
+ # HTTP header 'Accept' (if needed)
1890
+ header_params['Accept'] = @api_client.select_header_accept(['*/*', 'application/json']) unless header_params['Accept']
1891
+
1892
+ # form parameters
1893
+ form_params = opts[:form_params] || {}
1894
+
1895
+ # http body (model)
1896
+ post_body = opts[:debug_body]
1897
+
1898
+ # return_type
1899
+ return_type = opts[:debug_return_type] || 'File'
1900
+
1901
+ # auth_names
1902
+ auth_names = opts[:debug_auth_names] || ['Token']
1903
+
1904
+ new_options = opts.merge(
1905
+ :operation => :"DefaultApi.download_signing_document",
1906
+ :header_params => header_params,
1907
+ :query_params => query_params,
1908
+ :form_params => form_params,
1909
+ :body => post_body,
1910
+ :auth_names => auth_names,
1911
+ :return_type => return_type
1912
+ )
1913
+
1914
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1915
+ if @api_client.config.debugging
1916
+ @api_client.config.logger.debug "API called: DefaultApi#download_signing_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1917
+ end
1918
+ return data, status_code, headers
1919
+ end
1920
+
1655
1921
  # Autofill
1656
1922
  # Extract information from a document
1657
1923
  # @param extract_request [ExtractRequest]
@@ -2288,6 +2554,75 @@ module Onfido
2288
2554
  return data, status_code, headers
2289
2555
  end
2290
2556
 
2557
+ # Retrieve passkey
2558
+ # Returns a passkey's details.
2559
+ # @param username [String] Username that owns the passkey.
2560
+ # @param passkey_id [String] Passkey ID.
2561
+ # @param [Hash] opts the optional parameters
2562
+ # @return [Passkey]
2563
+ def find_passkey(username, passkey_id, opts = {})
2564
+ data, _status_code, _headers = find_passkey_with_http_info(username, passkey_id, opts)
2565
+ data
2566
+ end
2567
+
2568
+ # Retrieve passkey
2569
+ # Returns a passkey&#39;s details.
2570
+ # @param username [String] Username that owns the passkey.
2571
+ # @param passkey_id [String] Passkey ID.
2572
+ # @param [Hash] opts the optional parameters
2573
+ # @return [Array<(Passkey, Integer, Hash)>] Passkey data, response status code and response headers
2574
+ def find_passkey_with_http_info(username, passkey_id, opts = {})
2575
+ if @api_client.config.debugging
2576
+ @api_client.config.logger.debug 'Calling API: DefaultApi.find_passkey ...'
2577
+ end
2578
+ # verify the required parameter 'username' is set
2579
+ if @api_client.config.client_side_validation && username.nil?
2580
+ fail ArgumentError, "Missing the required parameter 'username' when calling DefaultApi.find_passkey"
2581
+ end
2582
+ # verify the required parameter 'passkey_id' is set
2583
+ if @api_client.config.client_side_validation && passkey_id.nil?
2584
+ fail ArgumentError, "Missing the required parameter 'passkey_id' when calling DefaultApi.find_passkey"
2585
+ end
2586
+ # resource path
2587
+ local_var_path = '/passkeys/{username}/{passkey_id}'.sub('{' + 'username' + '}', CGI.escape(username.to_s)).sub('{' + 'passkey_id' + '}', CGI.escape(passkey_id.to_s))
2588
+
2589
+ # query parameters
2590
+ query_params = opts[:query_params] || {}
2591
+
2592
+ # header parameters
2593
+ header_params = opts[:header_params] || {}
2594
+ # HTTP header 'Accept' (if needed)
2595
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2596
+
2597
+ # form parameters
2598
+ form_params = opts[:form_params] || {}
2599
+
2600
+ # http body (model)
2601
+ post_body = opts[:debug_body]
2602
+
2603
+ # return_type
2604
+ return_type = opts[:debug_return_type] || 'Passkey'
2605
+
2606
+ # auth_names
2607
+ auth_names = opts[:debug_auth_names] || ['Token']
2608
+
2609
+ new_options = opts.merge(
2610
+ :operation => :"DefaultApi.find_passkey",
2611
+ :header_params => header_params,
2612
+ :query_params => query_params,
2613
+ :form_params => form_params,
2614
+ :body => post_body,
2615
+ :auth_names => auth_names,
2616
+ :return_type => return_type
2617
+ )
2618
+
2619
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2620
+ if @api_client.config.debugging
2621
+ @api_client.config.logger.debug "API called: DefaultApi#find_passkey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2622
+ end
2623
+ return data, status_code, headers
2624
+ end
2625
+
2291
2626
  # Retrieve report
2292
2627
  # A single report can be retrieved using this endpoint with the corresponding unique identifier.
2293
2628
  # @param report_id [String]
@@ -2351,6 +2686,69 @@ module Onfido
2351
2686
  return data, status_code, headers
2352
2687
  end
2353
2688
 
2689
+ # Retrieve signing document
2690
+ # A single signing document can be retrieved by calling this endpoint with the signing document's unique identifier.
2691
+ # @param signing_document_id [String]
2692
+ # @param [Hash] opts the optional parameters
2693
+ # @return [SigningDocument]
2694
+ def find_signing_document(signing_document_id, opts = {})
2695
+ data, _status_code, _headers = find_signing_document_with_http_info(signing_document_id, opts)
2696
+ data
2697
+ end
2698
+
2699
+ # Retrieve signing document
2700
+ # A single signing document can be retrieved by calling this endpoint with the signing document&#39;s unique identifier.
2701
+ # @param signing_document_id [String]
2702
+ # @param [Hash] opts the optional parameters
2703
+ # @return [Array<(SigningDocument, Integer, Hash)>] SigningDocument data, response status code and response headers
2704
+ def find_signing_document_with_http_info(signing_document_id, opts = {})
2705
+ if @api_client.config.debugging
2706
+ @api_client.config.logger.debug 'Calling API: DefaultApi.find_signing_document ...'
2707
+ end
2708
+ # verify the required parameter 'signing_document_id' is set
2709
+ if @api_client.config.client_side_validation && signing_document_id.nil?
2710
+ fail ArgumentError, "Missing the required parameter 'signing_document_id' when calling DefaultApi.find_signing_document"
2711
+ end
2712
+ # resource path
2713
+ local_var_path = '/signing_documents/{signing_document_id}'.sub('{' + 'signing_document_id' + '}', CGI.escape(signing_document_id.to_s))
2714
+
2715
+ # query parameters
2716
+ query_params = opts[:query_params] || {}
2717
+
2718
+ # header parameters
2719
+ header_params = opts[:header_params] || {}
2720
+ # HTTP header 'Accept' (if needed)
2721
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2722
+
2723
+ # form parameters
2724
+ form_params = opts[:form_params] || {}
2725
+
2726
+ # http body (model)
2727
+ post_body = opts[:debug_body]
2728
+
2729
+ # return_type
2730
+ return_type = opts[:debug_return_type] || 'SigningDocument'
2731
+
2732
+ # auth_names
2733
+ auth_names = opts[:debug_auth_names] || ['Token']
2734
+
2735
+ new_options = opts.merge(
2736
+ :operation => :"DefaultApi.find_signing_document",
2737
+ :header_params => header_params,
2738
+ :query_params => query_params,
2739
+ :form_params => form_params,
2740
+ :body => post_body,
2741
+ :auth_names => auth_names,
2742
+ :return_type => return_type
2743
+ )
2744
+
2745
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2746
+ if @api_client.config.debugging
2747
+ @api_client.config.logger.debug "API called: DefaultApi#find_signing_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2748
+ end
2749
+ return data, status_code, headers
2750
+ end
2751
+
2354
2752
  # Retrieve Task
2355
2753
  # A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
2356
2754
  # @param workflow_run_id [String] The unique identifier of the Workflow Run to which the Task belongs.
@@ -3259,6 +3657,69 @@ module Onfido
3259
3657
  return data, status_code, headers
3260
3658
  end
3261
3659
 
3660
+ # List passkeys
3661
+ # Returns every passkey registered under the supplied username.
3662
+ # @param username [String] Username that owns the passkeys.
3663
+ # @param [Hash] opts the optional parameters
3664
+ # @return [PasskeysList]
3665
+ def list_passkeys(username, opts = {})
3666
+ data, _status_code, _headers = list_passkeys_with_http_info(username, opts)
3667
+ data
3668
+ end
3669
+
3670
+ # List passkeys
3671
+ # Returns every passkey registered under the supplied username.
3672
+ # @param username [String] Username that owns the passkeys.
3673
+ # @param [Hash] opts the optional parameters
3674
+ # @return [Array<(PasskeysList, Integer, Hash)>] PasskeysList data, response status code and response headers
3675
+ def list_passkeys_with_http_info(username, opts = {})
3676
+ if @api_client.config.debugging
3677
+ @api_client.config.logger.debug 'Calling API: DefaultApi.list_passkeys ...'
3678
+ end
3679
+ # verify the required parameter 'username' is set
3680
+ if @api_client.config.client_side_validation && username.nil?
3681
+ fail ArgumentError, "Missing the required parameter 'username' when calling DefaultApi.list_passkeys"
3682
+ end
3683
+ # resource path
3684
+ local_var_path = '/passkeys/{username}'.sub('{' + 'username' + '}', CGI.escape(username.to_s))
3685
+
3686
+ # query parameters
3687
+ query_params = opts[:query_params] || {}
3688
+
3689
+ # header parameters
3690
+ header_params = opts[:header_params] || {}
3691
+ # HTTP header 'Accept' (if needed)
3692
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
3693
+
3694
+ # form parameters
3695
+ form_params = opts[:form_params] || {}
3696
+
3697
+ # http body (model)
3698
+ post_body = opts[:debug_body]
3699
+
3700
+ # return_type
3701
+ return_type = opts[:debug_return_type] || 'PasskeysList'
3702
+
3703
+ # auth_names
3704
+ auth_names = opts[:debug_auth_names] || ['Token']
3705
+
3706
+ new_options = opts.merge(
3707
+ :operation => :"DefaultApi.list_passkeys",
3708
+ :header_params => header_params,
3709
+ :query_params => query_params,
3710
+ :form_params => form_params,
3711
+ :body => post_body,
3712
+ :auth_names => auth_names,
3713
+ :return_type => return_type
3714
+ )
3715
+
3716
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
3717
+ if @api_client.config.debugging
3718
+ @api_client.config.logger.debug "API called: DefaultApi#list_passkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3719
+ end
3720
+ return data, status_code, headers
3721
+ end
3722
+
3262
3723
  # Retrieve repeat attempts
3263
3724
  # Returns all repeat attempts for a given Document report
3264
3725
  # @param report_id [String]
@@ -3386,6 +3847,70 @@ module Onfido
3386
3847
  return data, status_code, headers
3387
3848
  end
3388
3849
 
3850
+ # List signing documents
3851
+ # All signing documents belonging to an applicant can be listed from this endpoint
3852
+ # @param applicant_id [String]
3853
+ # @param [Hash] opts the optional parameters
3854
+ # @return [SigningDocumentsList]
3855
+ def list_signing_documents(applicant_id, opts = {})
3856
+ data, _status_code, _headers = list_signing_documents_with_http_info(applicant_id, opts)
3857
+ data
3858
+ end
3859
+
3860
+ # List signing documents
3861
+ # All signing documents belonging to an applicant can be listed from this endpoint
3862
+ # @param applicant_id [String]
3863
+ # @param [Hash] opts the optional parameters
3864
+ # @return [Array<(SigningDocumentsList, Integer, Hash)>] SigningDocumentsList data, response status code and response headers
3865
+ def list_signing_documents_with_http_info(applicant_id, opts = {})
3866
+ if @api_client.config.debugging
3867
+ @api_client.config.logger.debug 'Calling API: DefaultApi.list_signing_documents ...'
3868
+ end
3869
+ # verify the required parameter 'applicant_id' is set
3870
+ if @api_client.config.client_side_validation && applicant_id.nil?
3871
+ fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.list_signing_documents"
3872
+ end
3873
+ # resource path
3874
+ local_var_path = '/signing_documents'
3875
+
3876
+ # query parameters
3877
+ query_params = opts[:query_params] || {}
3878
+ query_params[:'applicant_id'] = applicant_id
3879
+
3880
+ # header parameters
3881
+ header_params = opts[:header_params] || {}
3882
+ # HTTP header 'Accept' (if needed)
3883
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
3884
+
3885
+ # form parameters
3886
+ form_params = opts[:form_params] || {}
3887
+
3888
+ # http body (model)
3889
+ post_body = opts[:debug_body]
3890
+
3891
+ # return_type
3892
+ return_type = opts[:debug_return_type] || 'SigningDocumentsList'
3893
+
3894
+ # auth_names
3895
+ auth_names = opts[:debug_auth_names] || ['Token']
3896
+
3897
+ new_options = opts.merge(
3898
+ :operation => :"DefaultApi.list_signing_documents",
3899
+ :header_params => header_params,
3900
+ :query_params => query_params,
3901
+ :form_params => form_params,
3902
+ :body => post_body,
3903
+ :auth_names => auth_names,
3904
+ :return_type => return_type
3905
+ )
3906
+
3907
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
3908
+ if @api_client.config.debugging
3909
+ @api_client.config.logger.debug "API called: DefaultApi#list_signing_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3910
+ end
3911
+ return data, status_code, headers
3912
+ end
3913
+
3389
3914
  # List Tasks
3390
3915
  # The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
3391
3916
  # @param workflow_run_id [String] The unique identifier of the Workflow Run to which the Tasks belong.
@@ -3641,10 +4166,11 @@ module Onfido
3641
4166
  # @param [Hash] opts the optional parameters
3642
4167
  # @option opts [Integer] :page The number of the page to be retrieved. If not specified, defaults to 1. (default to 1)
3643
4168
  # @option opts [String] :status A list of comma separated status values to filter the results. Possible values are &#39;processing&#39;, &#39;awaiting_input&#39;, &#39;approved&#39;, &#39;declined&#39;, &#39;review&#39;, &#39;abandoned&#39; and &#39;error&#39;.
3644
- # @option opts [Time] :created_at_gt A ISO-8601 date to filter results with a created date greater than (after) the one provided.
3645
- # @option opts [Time] :created_at_lt A ISO-8601 date to filter results with a created date less than (before) the one provided.
4169
+ # @option opts [Date] :created_at_gt A ISO-8601 date to filter results with a created date greater than (after) the one provided.
4170
+ # @option opts [Date] :created_at_lt A ISO-8601 date to filter results with a created date less than (before) the one provided.
3646
4171
  # @option opts [String] :sort A string with the value &#39;desc&#39; or &#39;asc&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to &#39;desc&#39;. (default to 'desc')
3647
4172
  # @option opts [String] :applicant_id the applicant&#39;s id.
4173
+ # @option opts [Array<String>] :tags A list of tags to filter the results.
3648
4174
  # @return [Array<WorkflowRun>]
3649
4175
  def list_workflow_runs(opts = {})
3650
4176
  data, _status_code, _headers = list_workflow_runs_with_http_info(opts)
@@ -3656,10 +4182,11 @@ module Onfido
3656
4182
  # @param [Hash] opts the optional parameters
3657
4183
  # @option opts [Integer] :page The number of the page to be retrieved. If not specified, defaults to 1. (default to 1)
3658
4184
  # @option opts [String] :status A list of comma separated status values to filter the results. Possible values are &#39;processing&#39;, &#39;awaiting_input&#39;, &#39;approved&#39;, &#39;declined&#39;, &#39;review&#39;, &#39;abandoned&#39; and &#39;error&#39;.
3659
- # @option opts [Time] :created_at_gt A ISO-8601 date to filter results with a created date greater than (after) the one provided.
3660
- # @option opts [Time] :created_at_lt A ISO-8601 date to filter results with a created date less than (before) the one provided.
4185
+ # @option opts [Date] :created_at_gt A ISO-8601 date to filter results with a created date greater than (after) the one provided.
4186
+ # @option opts [Date] :created_at_lt A ISO-8601 date to filter results with a created date less than (before) the one provided.
3661
4187
  # @option opts [String] :sort A string with the value &#39;desc&#39; or &#39;asc&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to &#39;desc&#39;. (default to 'desc')
3662
4188
  # @option opts [String] :applicant_id the applicant&#39;s id.
4189
+ # @option opts [Array<String>] :tags A list of tags to filter the results.
3663
4190
  # @return [Array<(Array<WorkflowRun>, Integer, Hash)>] Array<WorkflowRun> data, response status code and response headers
3664
4191
  def list_workflow_runs_with_http_info(opts = {})
3665
4192
  if @api_client.config.debugging
@@ -3680,6 +4207,7 @@ module Onfido
3680
4207
  query_params[:'created_at_lt'] = opts[:'created_at_lt'] if !opts[:'created_at_lt'].nil?
3681
4208
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
3682
4209
  query_params[:'applicant_id'] = opts[:'applicant_id'] if !opts[:'applicant_id'].nil?
4210
+ query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
3683
4211
 
3684
4212
  # header parameters
3685
4213
  header_params = opts[:header_params] || {}
@@ -4171,6 +4699,86 @@ module Onfido
4171
4699
  return data, status_code, headers
4172
4700
  end
4173
4701
 
4702
+ # Update passkey
4703
+ # Updates a passkey's state.
4704
+ # @param username [String] Username that owns the passkey.
4705
+ # @param passkey_id [String] Passkey ID.
4706
+ # @param passkey_updater [PasskeyUpdater] Passkey update payload.
4707
+ # @param [Hash] opts the optional parameters
4708
+ # @return [Passkey]
4709
+ def update_passkey(username, passkey_id, passkey_updater, opts = {})
4710
+ data, _status_code, _headers = update_passkey_with_http_info(username, passkey_id, passkey_updater, opts)
4711
+ data
4712
+ end
4713
+
4714
+ # Update passkey
4715
+ # Updates a passkey&#39;s state.
4716
+ # @param username [String] Username that owns the passkey.
4717
+ # @param passkey_id [String] Passkey ID.
4718
+ # @param passkey_updater [PasskeyUpdater] Passkey update payload.
4719
+ # @param [Hash] opts the optional parameters
4720
+ # @return [Array<(Passkey, Integer, Hash)>] Passkey data, response status code and response headers
4721
+ def update_passkey_with_http_info(username, passkey_id, passkey_updater, opts = {})
4722
+ if @api_client.config.debugging
4723
+ @api_client.config.logger.debug 'Calling API: DefaultApi.update_passkey ...'
4724
+ end
4725
+ # verify the required parameter 'username' is set
4726
+ if @api_client.config.client_side_validation && username.nil?
4727
+ fail ArgumentError, "Missing the required parameter 'username' when calling DefaultApi.update_passkey"
4728
+ end
4729
+ # verify the required parameter 'passkey_id' is set
4730
+ if @api_client.config.client_side_validation && passkey_id.nil?
4731
+ fail ArgumentError, "Missing the required parameter 'passkey_id' when calling DefaultApi.update_passkey"
4732
+ end
4733
+ # verify the required parameter 'passkey_updater' is set
4734
+ if @api_client.config.client_side_validation && passkey_updater.nil?
4735
+ fail ArgumentError, "Missing the required parameter 'passkey_updater' when calling DefaultApi.update_passkey"
4736
+ end
4737
+ # resource path
4738
+ local_var_path = '/passkeys/{username}/{passkey_id}'.sub('{' + 'username' + '}', CGI.escape(username.to_s)).sub('{' + 'passkey_id' + '}', CGI.escape(passkey_id.to_s))
4739
+
4740
+ # query parameters
4741
+ query_params = opts[:query_params] || {}
4742
+
4743
+ # header parameters
4744
+ header_params = opts[:header_params] || {}
4745
+ # HTTP header 'Accept' (if needed)
4746
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
4747
+ # HTTP header 'Content-Type'
4748
+ content_type = @api_client.select_header_content_type(['application/json'])
4749
+ if !content_type.nil?
4750
+ header_params['Content-Type'] = content_type
4751
+ end
4752
+
4753
+ # form parameters
4754
+ form_params = opts[:form_params] || {}
4755
+
4756
+ # http body (model)
4757
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(passkey_updater)
4758
+
4759
+ # return_type
4760
+ return_type = opts[:debug_return_type] || 'Passkey'
4761
+
4762
+ # auth_names
4763
+ auth_names = opts[:debug_auth_names] || ['Token']
4764
+
4765
+ new_options = opts.merge(
4766
+ :operation => :"DefaultApi.update_passkey",
4767
+ :header_params => header_params,
4768
+ :query_params => query_params,
4769
+ :form_params => form_params,
4770
+ :body => post_body,
4771
+ :auth_names => auth_names,
4772
+ :return_type => return_type
4773
+ )
4774
+
4775
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
4776
+ if @api_client.config.debugging
4777
+ @api_client.config.logger.debug "API called: DefaultApi#update_passkey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4778
+ end
4779
+ return data, status_code, headers
4780
+ end
4781
+
4174
4782
  # Set match status (BETA)
4175
4783
  # Update the status of the given matches
4176
4784
  # @param monitor_id [String]
@@ -4559,5 +5167,81 @@ module Onfido
4559
5167
  end
4560
5168
  return data, status_code, headers
4561
5169
  end
5170
+
5171
+ # Upload a signing document
5172
+ # Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB.
5173
+ # @param applicant_id [String] The ID of the applicant whose signing document is being uploaded.
5174
+ # @param file [File] The file to be uploaded.
5175
+ # @param [Hash] opts the optional parameters
5176
+ # @return [SigningDocument]
5177
+ def upload_signing_document(applicant_id, file, opts = {})
5178
+ data, _status_code, _headers = upload_signing_document_with_http_info(applicant_id, file, opts)
5179
+ data
5180
+ end
5181
+
5182
+ # Upload a signing document
5183
+ # Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB.
5184
+ # @param applicant_id [String] The ID of the applicant whose signing document is being uploaded.
5185
+ # @param file [File] The file to be uploaded.
5186
+ # @param [Hash] opts the optional parameters
5187
+ # @return [Array<(SigningDocument, Integer, Hash)>] SigningDocument data, response status code and response headers
5188
+ def upload_signing_document_with_http_info(applicant_id, file, opts = {})
5189
+ if @api_client.config.debugging
5190
+ @api_client.config.logger.debug 'Calling API: DefaultApi.upload_signing_document ...'
5191
+ end
5192
+ # verify the required parameter 'applicant_id' is set
5193
+ if @api_client.config.client_side_validation && applicant_id.nil?
5194
+ fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.upload_signing_document"
5195
+ end
5196
+ # verify the required parameter 'file' is set
5197
+ if @api_client.config.client_side_validation && file.nil?
5198
+ fail ArgumentError, "Missing the required parameter 'file' when calling DefaultApi.upload_signing_document"
5199
+ end
5200
+ # resource path
5201
+ local_var_path = '/signing_documents'
5202
+
5203
+ # query parameters
5204
+ query_params = opts[:query_params] || {}
5205
+
5206
+ # header parameters
5207
+ header_params = opts[:header_params] || {}
5208
+ # HTTP header 'Accept' (if needed)
5209
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
5210
+ # HTTP header 'Content-Type'
5211
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
5212
+ if !content_type.nil?
5213
+ header_params['Content-Type'] = content_type
5214
+ end
5215
+
5216
+ # form parameters
5217
+ form_params = opts[:form_params] || {}
5218
+ form_params['applicant_id'] = applicant_id
5219
+ form_params['file'] = file
5220
+
5221
+ # http body (model)
5222
+ post_body = opts[:debug_body]
5223
+
5224
+ # return_type
5225
+ return_type = opts[:debug_return_type] || 'SigningDocument'
5226
+
5227
+ # auth_names
5228
+ auth_names = opts[:debug_auth_names] || ['Token']
5229
+
5230
+ new_options = opts.merge(
5231
+ :operation => :"DefaultApi.upload_signing_document",
5232
+ :header_params => header_params,
5233
+ :query_params => query_params,
5234
+ :form_params => form_params,
5235
+ :body => post_body,
5236
+ :auth_names => auth_names,
5237
+ :return_type => return_type
5238
+ )
5239
+
5240
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5241
+ if @api_client.config.debugging
5242
+ @api_client.config.logger.debug "API called: DefaultApi#upload_signing_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5243
+ end
5244
+ return data, status_code, headers
5245
+ end
4562
5246
  end
4563
5247
  end