onfido 5.6.0 → 6.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +39 -0
- data/MIGRATION.md +28 -0
- data/README.md +18 -2
- data/lib/onfido/api/default_api.rb +1191 -94
- data/lib/onfido/api_client.rb +7 -3
- data/lib/onfido/api_error.rb +1 -1
- data/lib/onfido/configuration.rb +89 -2
- data/lib/onfido/models/address.rb +30 -4
- data/lib/onfido/models/address_builder.rb +30 -4
- data/lib/onfido/models/address_shared.rb +30 -4
- data/lib/onfido/models/addresses_list.rb +10 -4
- data/lib/onfido/models/applicant.rb +20 -4
- data/lib/onfido/models/applicant_builder.rb +10 -4
- data/lib/onfido/models/applicant_consent.rb +30 -4
- data/lib/onfido/models/applicant_consent_builder.rb +30 -4
- data/lib/onfido/models/applicant_consent_name.rb +1 -1
- data/lib/onfido/models/applicant_create.rb +10 -4
- data/lib/onfido/models/applicant_request.rb +10 -4
- data/lib/onfido/models/applicant_response.rb +20 -4
- data/lib/onfido/models/applicant_shared.rb +10 -4
- data/lib/onfido/models/applicant_update.rb +10 -4
- data/lib/onfido/models/applicant_updater.rb +10 -4
- data/lib/onfido/models/applicants_list.rb +20 -4
- data/lib/onfido/models/biometric_token.rb +265 -0
- data/lib/onfido/models/biometric_token_data.rb +317 -0
- data/lib/onfido/models/biometric_token_response.rb +237 -0
- data/lib/onfido/models/biometric_token_updater.rb +262 -0
- data/lib/onfido/models/biometric_tokens_response.rb +239 -0
- data/lib/onfido/models/check.rb +30 -4
- data/lib/onfido/models/check_builder.rb +30 -4
- data/lib/onfido/models/check_request.rb +20 -4
- data/lib/onfido/models/check_response.rb +20 -4
- data/lib/onfido/models/check_shared.rb +20 -4
- data/lib/onfido/models/check_status.rb +1 -1
- data/lib/onfido/models/checks_list.rb +20 -4
- data/lib/onfido/models/complete_task_builder.rb +20 -4
- data/lib/onfido/models/complete_task_data_builder.rb +3 -4
- data/lib/onfido/models/country_codes.rb +1 -1
- data/lib/onfido/models/device_intelligence_breakdown.rb +14 -26
- data/lib/onfido/models/device_intelligence_breakdown_device.rb +10 -4
- data/lib/onfido/models/device_intelligence_breakdown_device_breakdown.rb +10 -4
- data/lib/onfido/models/device_intelligence_properties.rb +13 -7
- data/lib/onfido/models/{device_intelligence_breakdown_properties_device.rb → device_intelligence_properties_device.rb} +33 -7
- data/lib/onfido/models/{device_intelligence_breakdown_properties_geolocation.rb → device_intelligence_properties_geolocation.rb} +12 -6
- data/lib/onfido/models/{device_intelligence_breakdown_properties_ip.rb → device_intelligence_properties_ip.rb} +12 -6
- data/lib/onfido/models/device_intelligence_report.rb +30 -4
- data/lib/onfido/models/document.rb +20 -4
- data/lib/onfido/models/document_breakdown.rb +10 -4
- data/lib/onfido/models/document_breakdown_age_validation.rb +10 -4
- data/lib/onfido/models/document_breakdown_age_validation_breakdown.rb +10 -4
- data/lib/onfido/models/document_breakdown_compromised_document.rb +10 -4
- data/lib/onfido/models/document_breakdown_compromised_document_breakdown.rb +10 -4
- data/lib/onfido/models/document_breakdown_data_comparison.rb +10 -4
- data/lib/onfido/models/document_breakdown_data_comparison_breakdown.rb +10 -4
- data/lib/onfido/models/document_breakdown_data_comparison_breakdown_issuing_country.rb +10 -4
- data/lib/onfido/models/document_breakdown_data_consistency.rb +10 -4
- data/lib/onfido/models/document_breakdown_data_consistency_breakdown.rb +10 -4
- data/lib/onfido/models/document_breakdown_data_validation.rb +10 -4
- data/lib/onfido/models/document_breakdown_data_validation_breakdown.rb +10 -4
- data/lib/onfido/models/document_breakdown_data_validation_breakdown_document_expiration.rb +10 -4
- data/lib/onfido/models/document_breakdown_data_validation_breakdown_expiry_date.rb +10 -4
- data/lib/onfido/models/document_breakdown_image_integrity.rb +10 -4
- data/lib/onfido/models/document_breakdown_image_integrity_breakdown.rb +10 -4
- data/lib/onfido/models/document_breakdown_image_integrity_breakdown_colour_picture.rb +10 -4
- data/lib/onfido/models/document_breakdown_image_integrity_breakdown_conclusive_document_quality.rb +10 -4
- data/lib/onfido/models/document_breakdown_image_integrity_breakdown_image_quality.rb +10 -4
- data/lib/onfido/models/document_breakdown_image_integrity_breakdown_supported_document.rb +10 -4
- data/lib/onfido/models/document_breakdown_issuing_authority.rb +10 -4
- data/lib/onfido/models/document_breakdown_issuing_authority_breakdown.rb +10 -4
- data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_active_authentication.rb +10 -4
- data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_passive_authentication.rb +10 -4
- data/lib/onfido/models/document_breakdown_police_record.rb +10 -4
- data/lib/onfido/models/document_breakdown_visual_authenticity.rb +10 -4
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown.rb +10 -4
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_digital_tampering.rb +10 -4
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_face_detection.rb +10 -4
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_fonts.rb +10 -4
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_original_document_present.rb +10 -4
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_other.rb +10 -4
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_picture_face_integrity.rb +10 -4
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_security_features.rb +10 -4
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_template.rb +10 -4
- data/lib/onfido/models/document_cdq_reasons.rb +10 -4
- data/lib/onfido/models/document_iq_reasons.rb +10 -4
- data/lib/onfido/models/document_odp_reasons.rb +10 -4
- data/lib/onfido/models/document_properties.rb +20 -16
- data/lib/onfido/models/document_properties_address_lines.rb +10 -4
- data/lib/onfido/models/document_properties_barcode_inner.rb +10 -4
- data/lib/onfido/models/document_properties_document_classification.rb +10 -4
- data/lib/onfido/models/document_properties_document_numbers_inner.rb +10 -4
- data/lib/onfido/models/document_properties_driving_licence_information_item.rb +10 -4
- data/lib/onfido/models/document_properties_extracted_data.rb +10 -4
- data/lib/onfido/models/document_properties_nfc.rb +10 -4
- data/lib/onfido/models/document_properties_with_driving_licence_information.rb +697 -0
- data/lib/onfido/models/document_report.rb +30 -4
- data/lib/onfido/models/document_report_shared.rb +10 -4
- data/lib/onfido/models/document_response.rb +20 -4
- data/lib/onfido/models/document_shared.rb +10 -4
- data/lib/onfido/models/document_types.rb +4 -2
- data/lib/onfido/models/document_video_report.rb +30 -4
- data/lib/onfido/models/document_video_with_address_information_report.rb +30 -4
- data/lib/onfido/models/document_with_address_information_report.rb +30 -4
- data/lib/onfido/models/document_with_driver_verification_report.rb +30 -4
- data/lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb +20 -16
- data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle.rb +10 -4
- data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner.rb +10 -4
- data/lib/onfido/models/document_with_driving_licence_information_report.rb +31 -5
- data/lib/onfido/models/documents_list.rb +20 -4
- data/lib/onfido/models/error.rb +10 -4
- data/lib/onfido/models/error1.rb +10 -4
- data/lib/onfido/models/error_properties.rb +10 -4
- data/lib/onfido/models/error_properties1.rb +10 -4
- data/lib/onfido/models/extract_request.rb +20 -4
- data/lib/onfido/models/extraction.rb +10 -4
- data/lib/onfido/models/extraction_document_classification.rb +10 -4
- data/lib/onfido/models/extraction_extracted_data.rb +10 -4
- data/lib/onfido/models/facial_similarity_motion_breakdown.rb +10 -4
- data/lib/onfido/models/facial_similarity_motion_breakdown_face_comparison.rb +10 -4
- data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity.rb +10 -4
- data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown.rb +10 -4
- data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_face_detected.rb +10 -4
- data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_source_integrity.rb +10 -4
- data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity.rb +10 -4
- data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown.rb +10 -4
- data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +10 -4
- data/lib/onfido/models/facial_similarity_motion_properties.rb +10 -4
- data/lib/onfido/models/facial_similarity_motion_report.rb +30 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match_properties.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_face_detected.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_source_integrity.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection_properties.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_fully_auto_properties.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_fully_auto_report.rb +30 -4
- data/lib/onfido/models/facial_similarity_photo_properties.rb +10 -4
- data/lib/onfido/models/facial_similarity_photo_report.rb +30 -4
- data/lib/onfido/models/facial_similarity_report_media.rb +20 -4
- data/lib/onfido/models/facial_similarity_report_shared.rb +10 -4
- data/lib/onfido/models/facial_similarity_video_breakdown.rb +10 -4
- data/lib/onfido/models/facial_similarity_video_breakdown_face_comparison.rb +10 -4
- data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity.rb +10 -4
- data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown.rb +10 -4
- data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected.rb +10 -4
- data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity.rb +10 -4
- data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity.rb +10 -4
- data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown.rb +10 -4
- data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected.rb +10 -4
- data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +10 -4
- data/lib/onfido/models/facial_similarity_video_properties.rb +10 -4
- data/lib/onfido/models/facial_similarity_video_report.rb +30 -4
- data/lib/onfido/models/id_number.rb +10 -4
- data/lib/onfido/models/id_photo.rb +20 -4
- data/lib/onfido/models/id_photo_response.rb +20 -4
- data/lib/onfido/models/id_photos_list.rb +20 -4
- data/lib/onfido/models/identity_enhanced_breakdown.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_address.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies_properties.rb +11 -5
- data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_telephone_database.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_voting_register.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_voting_register.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_mortality.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_sources.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources.rb +10 -4
- data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources_properties.rb +11 -5
- data/lib/onfido/models/identity_enhanced_properties.rb +10 -4
- data/lib/onfido/models/identity_enhanced_properties_matched_addresses_inner.rb +10 -4
- data/lib/onfido/models/identity_enhanced_report.rb +30 -4
- data/lib/onfido/models/idr_ssn_breakdown.rb +10 -4
- data/lib/onfido/models/idr_ssn_breakdown_breakdown.rb +10 -4
- data/lib/onfido/models/idr_ssn_breakdown_breakdown_full_match.rb +10 -4
- data/lib/onfido/models/idr_ssn_breakdown_breakdown_last4_digits_match.rb +10 -4
- data/lib/onfido/models/india_pan_report.rb +30 -4
- data/lib/onfido/models/india_pan_report_all_of_breakdown.rb +10 -4
- data/lib/onfido/models/india_pan_report_all_of_breakdown_device.rb +10 -4
- data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown.rb +10 -4
- data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown_pan_valid.rb +10 -4
- data/lib/onfido/models/india_pan_report_all_of_properties.rb +10 -4
- data/lib/onfido/models/india_pan_report_all_of_properties_device.rb +10 -4
- data/lib/onfido/models/invalidated_biometric_token_response.rb +237 -0
- data/lib/onfido/models/invalidated_biometric_token_summary.rb +238 -0
- data/lib/onfido/models/invalidated_biometric_token_summary_deleted_items.rb +239 -0
- data/lib/onfido/models/invalidated_biometric_tokens_response.rb +237 -0
- data/lib/onfido/models/known_faces_breakdown.rb +10 -4
- data/lib/onfido/models/known_faces_breakdown_image_integrity.rb +10 -4
- data/lib/onfido/models/known_faces_breakdown_previously_seen_faces.rb +10 -4
- data/lib/onfido/models/known_faces_properties.rb +10 -4
- data/lib/onfido/models/known_faces_properties_matches_inner.rb +10 -4
- data/lib/onfido/models/known_faces_report.rb +30 -4
- data/lib/onfido/models/live_photo.rb +20 -4
- data/lib/onfido/models/live_photo_response.rb +20 -4
- data/lib/onfido/models/live_photos_list.rb +20 -4
- data/lib/onfido/models/live_video.rb +10 -4
- data/lib/onfido/models/live_videos_list.rb +20 -4
- data/lib/onfido/models/location.rb +10 -4
- data/lib/onfido/models/location_builder.rb +10 -4
- data/lib/onfido/models/location_shared.rb +10 -4
- data/lib/onfido/models/motion_capture.rb +10 -4
- data/lib/onfido/models/motion_captures_list.rb +20 -4
- data/lib/onfido/models/passkey.rb +353 -0
- data/lib/onfido/models/passkey_updater.rb +262 -0
- data/lib/onfido/models/passkeys_list.rb +239 -0
- data/lib/onfido/models/photo_auto_reasons.rb +10 -4
- data/lib/onfido/models/photo_reasons.rb +10 -4
- data/lib/onfido/models/proof_of_address_breakdown.rb +10 -4
- data/lib/onfido/models/proof_of_address_breakdown_data_comparison.rb +10 -4
- data/lib/onfido/models/proof_of_address_breakdown_data_comparison_breakdown.rb +10 -4
- data/lib/onfido/models/proof_of_address_breakdown_document_classification.rb +10 -4
- data/lib/onfido/models/proof_of_address_breakdown_document_classification_breakdown.rb +10 -4
- data/lib/onfido/models/proof_of_address_breakdown_image_integrity.rb +10 -4
- data/lib/onfido/models/proof_of_address_breakdown_image_integrity_breakdown.rb +10 -4
- data/lib/onfido/models/proof_of_address_properties.rb +10 -4
- data/lib/onfido/models/proof_of_address_report.rb +30 -4
- data/lib/onfido/models/repeat_attempts_list.rb +20 -4
- data/lib/onfido/models/repeat_attempts_list_repeat_attempts_inner.rb +10 -4
- data/lib/onfido/models/report.rb +1 -1
- data/lib/onfido/models/report_configuration.rb +10 -4
- data/lib/onfido/models/report_configuration_facial_similarity.rb +10 -4
- data/lib/onfido/models/report_document.rb +20 -4
- data/lib/onfido/models/report_name.rb +1 -1
- data/lib/onfido/models/report_result.rb +1 -1
- data/lib/onfido/models/report_shared.rb +30 -4
- data/lib/onfido/models/report_status.rb +1 -1
- data/lib/onfido/models/report_sub_result.rb +1 -1
- data/lib/onfido/models/reports_list.rb +20 -4
- data/lib/onfido/models/results_feedback.rb +10 -4
- data/lib/onfido/models/sdk_token.rb +20 -4
- data/lib/onfido/models/sdk_token_builder.rb +20 -4
- data/lib/onfido/models/sdk_token_request.rb +20 -4
- data/lib/onfido/models/sdk_token_response.rb +20 -4
- data/lib/onfido/models/signing_document.rb +316 -0
- data/lib/onfido/models/signing_document_response.rb +298 -0
- data/lib/onfido/models/{device_intelligence_breakdown_breakdown.rb → signing_document_shared.rb} +20 -13
- data/lib/onfido/models/signing_documents_list.rb +239 -0
- data/lib/onfido/models/task.rb +10 -4
- data/lib/onfido/models/task_item.rb +10 -4
- data/lib/onfido/models/timeline_file_reference.rb +30 -4
- data/lib/onfido/models/updated_biometric_token_response.rb +237 -0
- data/lib/onfido/models/us_driving_licence_breakdown.rb +10 -4
- data/lib/onfido/models/us_driving_licence_breakdown_address.rb +10 -4
- data/lib/onfido/models/us_driving_licence_breakdown_address_breakdown.rb +10 -4
- data/lib/onfido/models/us_driving_licence_breakdown_document.rb +10 -4
- data/lib/onfido/models/us_driving_licence_breakdown_document_breakdown.rb +10 -4
- data/lib/onfido/models/us_driving_licence_breakdown_personal.rb +10 -4
- data/lib/onfido/models/us_driving_licence_breakdown_personal_breakdown.rb +10 -4
- data/lib/onfido/models/us_driving_licence_builder.rb +20 -4
- data/lib/onfido/models/us_driving_licence_report.rb +30 -4
- data/lib/onfido/models/us_driving_licence_shared.rb +20 -4
- data/lib/onfido/models/video_reasons.rb +10 -4
- data/lib/onfido/models/watchlist_aml_breakdown.rb +10 -4
- data/lib/onfido/models/watchlist_aml_breakdown_adverse_media.rb +10 -4
- data/lib/onfido/models/watchlist_aml_breakdown_legal_and_regulatory_warnings.rb +10 -4
- data/lib/onfido/models/watchlist_aml_breakdown_politically_exposed_person.rb +10 -4
- data/lib/onfido/models/watchlist_aml_breakdown_sanction.rb +10 -4
- data/lib/onfido/models/watchlist_aml_properties.rb +10 -4
- data/lib/onfido/models/watchlist_aml_report.rb +30 -4
- data/lib/onfido/models/watchlist_enhanced_breakdown.rb +10 -4
- data/lib/onfido/models/watchlist_enhanced_properties.rb +10 -4
- data/lib/onfido/models/watchlist_enhanced_properties_records_inner.rb +10 -4
- data/lib/onfido/models/watchlist_enhanced_properties_records_inner_address_inner.rb +10 -4
- data/lib/onfido/models/watchlist_enhanced_properties_records_inner_alias_inner.rb +10 -4
- data/lib/onfido/models/watchlist_enhanced_properties_records_inner_associate_inner.rb +10 -4
- data/lib/onfido/models/watchlist_enhanced_properties_records_inner_attribute_inner.rb +10 -4
- data/lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner.rb +10 -4
- data/lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner_source.rb +10 -4
- data/lib/onfido/models/watchlist_enhanced_properties_records_inner_source_inner.rb +10 -4
- data/lib/onfido/models/watchlist_enhanced_report.rb +30 -4
- data/lib/onfido/models/watchlist_mesh_added_mentions.rb +247 -0
- data/lib/onfido/models/watchlist_mesh_alert_risk.rb +323 -0
- data/lib/onfido/models/watchlist_mesh_alert_risk1.rb +316 -0
- data/lib/onfido/models/watchlist_mesh_associate.rb +231 -0
- data/lib/onfido/models/watchlist_mesh_date_value.rb +231 -0
- data/lib/onfido/models/{device_intelligence_breakdown_properties.rb → watchlist_mesh_field.rb} +34 -25
- data/lib/onfido/models/watchlist_mesh_image.rb +231 -0
- data/lib/onfido/models/watchlist_mesh_lists.rb +309 -0
- data/lib/onfido/models/watchlist_mesh_media.rb +261 -0
- data/lib/onfido/models/watchlist_mesh_name.rb +231 -0
- data/lib/onfido/models/watchlist_mesh_pep.rb +369 -0
- data/lib/onfido/models/watchlist_mesh_person.rb +283 -0
- data/lib/onfido/models/watchlist_mesh_profile.rb +273 -0
- data/lib/onfido/models/watchlist_mesh_risk_decision.rb +43 -0
- data/lib/onfido/models/watchlist_mesh_risk_detail.rb +255 -0
- data/lib/onfido/models/watchlist_mesh_risk_indicators.rb +271 -0
- data/lib/onfido/models/watchlist_mesh_sanctions.rb +309 -0
- data/lib/onfido/models/watchlist_monitor.rb +30 -4
- data/lib/onfido/models/watchlist_monitor_builder.rb +20 -4
- data/lib/onfido/models/watchlist_monitor_match.rb +10 -4
- data/lib/onfido/models/watchlist_monitor_matches_list.rb +20 -4
- data/lib/onfido/models/watchlist_monitor_matches_updater.rb +10 -4
- data/lib/onfido/models/watchlist_monitor_response.rb +20 -4
- data/lib/onfido/models/watchlist_monitor_shared.rb +20 -4
- data/lib/onfido/models/watchlist_monitors_list.rb +20 -4
- data/lib/onfido/models/watchlist_peps_only_report.rb +30 -4
- data/lib/onfido/models/watchlist_sanctions_only_report.rb +30 -4
- data/lib/onfido/models/watchlist_standard_breakdown.rb +10 -4
- data/lib/onfido/models/watchlist_standard_properties.rb +10 -4
- data/lib/onfido/models/watchlist_standard_report.rb +30 -4
- data/lib/onfido/models/webhook.rb +31 -5
- data/lib/onfido/models/webhook_builder.rb +31 -5
- data/lib/onfido/models/webhook_create.rb +31 -5
- data/lib/onfido/models/webhook_event.rb +10 -4
- data/lib/onfido/models/webhook_event_object_status.rb +1 -1
- data/lib/onfido/models/webhook_event_payload.rb +20 -4
- data/lib/onfido/models/webhook_event_payload_object.rb +20 -4
- data/lib/onfido/models/webhook_event_payload_resource.rb +54 -5
- data/lib/onfido/models/webhook_event_resource_status.rb +50 -0
- data/lib/onfido/models/webhook_event_resource_type.rb +1 -1
- data/lib/onfido/models/webhook_event_type.rb +1 -1
- data/lib/onfido/models/webhook_resend.rb +10 -4
- data/lib/onfido/models/webhook_response.rb +31 -5
- data/lib/onfido/models/webhook_shared.rb +10 -4
- data/lib/onfido/models/webhook_update.rb +21 -5
- data/lib/onfido/models/webhook_updater.rb +21 -5
- data/lib/onfido/models/webhooks_list.rb +20 -4
- data/lib/onfido/models/webhooks_resend_item.rb +30 -4
- data/lib/onfido/models/workflow_run.rb +40 -4
- data/lib/onfido/models/workflow_run_builder.rb +30 -4
- data/lib/onfido/models/workflow_run_error.rb +10 -4
- data/lib/onfido/models/workflow_run_link.rb +10 -4
- data/lib/onfido/models/workflow_run_request.rb +10 -4
- data/lib/onfido/models/workflow_run_response.rb +20 -4
- data/lib/onfido/models/workflow_run_shared.rb +30 -4
- data/lib/onfido/models/workflow_run_status.rb +1 -1
- data/lib/onfido/version.rb +2 -2
- data/lib/onfido.rb +40 -6
- data/onfido.gemspec +1 -1
- data/spec/integrations/biometric_token_spec.rb +122 -0
- data/spec/integrations/document_spec.rb +8 -1
- data/spec/integrations/media/nfc_data.json +11768 -0
- data/spec/integrations/media/sample_signing_document.pdf +33 -0
- data/spec/integrations/passkey_spec.rb +63 -0
- data/spec/integrations/signing_document_spec.rb +61 -0
- data/spec/integrations/watchlist_alert_risk_spec.rb +66 -0
- data/spec/integrations/workflow_run_spec.rb +8 -4
- data/spec/shared_contexts/with_document.rb +0 -1
- data/spec/shared_contexts/with_onfido.rb +14 -2
- data/spec/shared_contexts/with_signing_document.rb +15 -0
- data/spec/spec_helper.rb +7 -8
- metadata +71 -23
|
@@ -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.
|
|
9
|
+
Generator version: 7.16.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -63,7 +63,7 @@ module Onfido
|
|
|
63
63
|
return_type = opts[:debug_return_type]
|
|
64
64
|
|
|
65
65
|
# auth_names
|
|
66
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
66
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
67
67
|
|
|
68
68
|
new_options = opts.merge(
|
|
69
69
|
:operation => :"DefaultApi.cancel_report",
|
|
@@ -143,7 +143,7 @@ module Onfido
|
|
|
143
143
|
return_type = opts[:debug_return_type]
|
|
144
144
|
|
|
145
145
|
# auth_names
|
|
146
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
146
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
147
147
|
|
|
148
148
|
new_options = opts.merge(
|
|
149
149
|
:operation => :"DefaultApi.complete_task",
|
|
@@ -211,7 +211,7 @@ module Onfido
|
|
|
211
211
|
return_type = opts[:debug_return_type] || 'Applicant'
|
|
212
212
|
|
|
213
213
|
# auth_names
|
|
214
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
214
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
215
215
|
|
|
216
216
|
new_options = opts.merge(
|
|
217
217
|
:operation => :"DefaultApi.create_applicant",
|
|
@@ -279,7 +279,7 @@ module Onfido
|
|
|
279
279
|
return_type = opts[:debug_return_type] || 'Check'
|
|
280
280
|
|
|
281
281
|
# auth_names
|
|
282
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
282
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
283
283
|
|
|
284
284
|
new_options = opts.merge(
|
|
285
285
|
:operation => :"DefaultApi.create_check",
|
|
@@ -342,7 +342,7 @@ module Onfido
|
|
|
342
342
|
return_type = opts[:debug_return_type] || 'TimelineFileReference'
|
|
343
343
|
|
|
344
344
|
# auth_names
|
|
345
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
345
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
346
346
|
|
|
347
347
|
new_options = opts.merge(
|
|
348
348
|
:operation => :"DefaultApi.create_timeline_file",
|
|
@@ -410,7 +410,7 @@ module Onfido
|
|
|
410
410
|
return_type = opts[:debug_return_type] || 'WatchlistMonitor'
|
|
411
411
|
|
|
412
412
|
# auth_names
|
|
413
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
413
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
414
414
|
|
|
415
415
|
new_options = opts.merge(
|
|
416
416
|
:operation => :"DefaultApi.create_watchlist_monitor",
|
|
@@ -478,7 +478,7 @@ module Onfido
|
|
|
478
478
|
return_type = opts[:debug_return_type] || 'Webhook'
|
|
479
479
|
|
|
480
480
|
# auth_names
|
|
481
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
481
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
482
482
|
|
|
483
483
|
new_options = opts.merge(
|
|
484
484
|
:operation => :"DefaultApi.create_webhook",
|
|
@@ -546,7 +546,7 @@ module Onfido
|
|
|
546
546
|
return_type = opts[:debug_return_type] || 'WorkflowRun'
|
|
547
547
|
|
|
548
548
|
# auth_names
|
|
549
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
549
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
550
550
|
|
|
551
551
|
new_options = opts.merge(
|
|
552
552
|
:operation => :"DefaultApi.create_workflow_run",
|
|
@@ -609,7 +609,7 @@ module Onfido
|
|
|
609
609
|
return_type = opts[:debug_return_type]
|
|
610
610
|
|
|
611
611
|
# auth_names
|
|
612
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
612
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
613
613
|
|
|
614
614
|
new_options = opts.merge(
|
|
615
615
|
:operation => :"DefaultApi.delete_applicant",
|
|
@@ -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] || ['OAuth2ClientCredentials', '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] || ['OAuth2ClientCredentials', '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]
|
|
@@ -672,7 +804,7 @@ module Onfido
|
|
|
672
804
|
return_type = opts[:debug_return_type]
|
|
673
805
|
|
|
674
806
|
# auth_names
|
|
675
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
807
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
676
808
|
|
|
677
809
|
new_options = opts.merge(
|
|
678
810
|
:operation => :"DefaultApi.delete_watchlist_monitor",
|
|
@@ -735,7 +867,7 @@ module Onfido
|
|
|
735
867
|
return_type = opts[:debug_return_type]
|
|
736
868
|
|
|
737
869
|
# auth_names
|
|
738
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
870
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
739
871
|
|
|
740
872
|
new_options = opts.merge(
|
|
741
873
|
:operation => :"DefaultApi.delete_webhook",
|
|
@@ -806,7 +938,7 @@ module Onfido
|
|
|
806
938
|
return_type = opts[:debug_return_type] || 'File'
|
|
807
939
|
|
|
808
940
|
# auth_names
|
|
809
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
941
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
810
942
|
|
|
811
943
|
new_options = opts.merge(
|
|
812
944
|
:operation => :"DefaultApi.download_aes_document",
|
|
@@ -869,7 +1001,7 @@ module Onfido
|
|
|
869
1001
|
return_type = opts[:debug_return_type] || 'File'
|
|
870
1002
|
|
|
871
1003
|
# auth_names
|
|
872
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1004
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
873
1005
|
|
|
874
1006
|
new_options = opts.merge(
|
|
875
1007
|
:operation => :"DefaultApi.download_check",
|
|
@@ -932,7 +1064,7 @@ module Onfido
|
|
|
932
1064
|
return_type = opts[:debug_return_type] || 'File'
|
|
933
1065
|
|
|
934
1066
|
# auth_names
|
|
935
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1067
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
936
1068
|
|
|
937
1069
|
new_options = opts.merge(
|
|
938
1070
|
:operation => :"DefaultApi.download_document",
|
|
@@ -995,7 +1127,7 @@ module Onfido
|
|
|
995
1127
|
return_type = opts[:debug_return_type] || 'File'
|
|
996
1128
|
|
|
997
1129
|
# auth_names
|
|
998
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1130
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
999
1131
|
|
|
1000
1132
|
new_options = opts.merge(
|
|
1001
1133
|
:operation => :"DefaultApi.download_document_video",
|
|
@@ -1058,7 +1190,7 @@ module Onfido
|
|
|
1058
1190
|
return_type = opts[:debug_return_type] || 'File'
|
|
1059
1191
|
|
|
1060
1192
|
# auth_names
|
|
1061
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1193
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1062
1194
|
|
|
1063
1195
|
new_options = opts.merge(
|
|
1064
1196
|
:operation => :"DefaultApi.download_evidence_folder",
|
|
@@ -1121,7 +1253,7 @@ module Onfido
|
|
|
1121
1253
|
return_type = opts[:debug_return_type] || 'File'
|
|
1122
1254
|
|
|
1123
1255
|
# auth_names
|
|
1124
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1256
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1125
1257
|
|
|
1126
1258
|
new_options = opts.merge(
|
|
1127
1259
|
:operation => :"DefaultApi.download_id_photo",
|
|
@@ -1184,7 +1316,7 @@ module Onfido
|
|
|
1184
1316
|
return_type = opts[:debug_return_type] || 'File'
|
|
1185
1317
|
|
|
1186
1318
|
# auth_names
|
|
1187
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1319
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1188
1320
|
|
|
1189
1321
|
new_options = opts.merge(
|
|
1190
1322
|
:operation => :"DefaultApi.download_live_photo",
|
|
@@ -1247,7 +1379,7 @@ module Onfido
|
|
|
1247
1379
|
return_type = opts[:debug_return_type] || 'File'
|
|
1248
1380
|
|
|
1249
1381
|
# auth_names
|
|
1250
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1382
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1251
1383
|
|
|
1252
1384
|
new_options = opts.merge(
|
|
1253
1385
|
:operation => :"DefaultApi.download_live_video",
|
|
@@ -1310,7 +1442,7 @@ module Onfido
|
|
|
1310
1442
|
return_type = opts[:debug_return_type] || 'File'
|
|
1311
1443
|
|
|
1312
1444
|
# auth_names
|
|
1313
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1445
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1314
1446
|
|
|
1315
1447
|
new_options = opts.merge(
|
|
1316
1448
|
:operation => :"DefaultApi.download_live_video_frame",
|
|
@@ -1373,7 +1505,7 @@ module Onfido
|
|
|
1373
1505
|
return_type = opts[:debug_return_type] || 'File'
|
|
1374
1506
|
|
|
1375
1507
|
# auth_names
|
|
1376
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1508
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1377
1509
|
|
|
1378
1510
|
new_options = opts.merge(
|
|
1379
1511
|
:operation => :"DefaultApi.download_motion_capture",
|
|
@@ -1436,7 +1568,7 @@ module Onfido
|
|
|
1436
1568
|
return_type = opts[:debug_return_type] || 'File'
|
|
1437
1569
|
|
|
1438
1570
|
# auth_names
|
|
1439
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1571
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1440
1572
|
|
|
1441
1573
|
new_options = opts.merge(
|
|
1442
1574
|
:operation => :"DefaultApi.download_motion_capture_frame",
|
|
@@ -1499,7 +1631,7 @@ module Onfido
|
|
|
1499
1631
|
return_type = opts[:debug_return_type] || 'File'
|
|
1500
1632
|
|
|
1501
1633
|
# auth_names
|
|
1502
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1634
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1503
1635
|
|
|
1504
1636
|
new_options = opts.merge(
|
|
1505
1637
|
:operation => :"DefaultApi.download_nfc_face",
|
|
@@ -1570,7 +1702,7 @@ module Onfido
|
|
|
1570
1702
|
return_type = opts[:debug_return_type] || 'File'
|
|
1571
1703
|
|
|
1572
1704
|
# auth_names
|
|
1573
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1705
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1574
1706
|
|
|
1575
1707
|
new_options = opts.merge(
|
|
1576
1708
|
:operation => :"DefaultApi.download_qes_document",
|
|
@@ -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] || ['OAuth2ClientCredentials', '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
|
|
@@ -1633,7 +1836,7 @@ module Onfido
|
|
|
1633
1836
|
return_type = opts[:debug_return_type] || 'File'
|
|
1634
1837
|
|
|
1635
1838
|
# auth_names
|
|
1636
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1839
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1637
1840
|
|
|
1638
1841
|
new_options = opts.merge(
|
|
1639
1842
|
:operation => :"DefaultApi.download_signed_evidence_file",
|
|
@@ -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] || ['OAuth2ClientCredentials', '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]
|
|
@@ -1701,7 +1967,7 @@ module Onfido
|
|
|
1701
1967
|
return_type = opts[:debug_return_type] || 'Extraction'
|
|
1702
1968
|
|
|
1703
1969
|
# auth_names
|
|
1704
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
1970
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1705
1971
|
|
|
1706
1972
|
new_options = opts.merge(
|
|
1707
1973
|
:operation => :"DefaultApi.extract",
|
|
@@ -1765,7 +2031,7 @@ module Onfido
|
|
|
1765
2031
|
return_type = opts[:debug_return_type] || 'AddressesList'
|
|
1766
2032
|
|
|
1767
2033
|
# auth_names
|
|
1768
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
2034
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1769
2035
|
|
|
1770
2036
|
new_options = opts.merge(
|
|
1771
2037
|
:operation => :"DefaultApi.find_addresses",
|
|
@@ -1828,7 +2094,7 @@ module Onfido
|
|
|
1828
2094
|
return_type = opts[:debug_return_type] || 'Applicant'
|
|
1829
2095
|
|
|
1830
2096
|
# auth_names
|
|
1831
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
2097
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1832
2098
|
|
|
1833
2099
|
new_options = opts.merge(
|
|
1834
2100
|
:operation => :"DefaultApi.find_applicant",
|
|
@@ -1891,7 +2157,7 @@ module Onfido
|
|
|
1891
2157
|
return_type = opts[:debug_return_type] || 'Array<ApplicantConsent>'
|
|
1892
2158
|
|
|
1893
2159
|
# auth_names
|
|
1894
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
2160
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1895
2161
|
|
|
1896
2162
|
new_options = opts.merge(
|
|
1897
2163
|
:operation => :"DefaultApi.find_applicant_consents",
|
|
@@ -1910,6 +2176,75 @@ module Onfido
|
|
|
1910
2176
|
return data, status_code, headers
|
|
1911
2177
|
end
|
|
1912
2178
|
|
|
2179
|
+
# Retrieve biometric token
|
|
2180
|
+
# Returns a biometric token's details.
|
|
2181
|
+
# @param user_id [String] Customer user ID that owns the biometric token.
|
|
2182
|
+
# @param token_uuid [String] Biometric token UUID.
|
|
2183
|
+
# @param [Hash] opts the optional parameters
|
|
2184
|
+
# @return [BiometricTokenResponse]
|
|
2185
|
+
def find_biometric_token(user_id, token_uuid, opts = {})
|
|
2186
|
+
data, _status_code, _headers = find_biometric_token_with_http_info(user_id, token_uuid, opts)
|
|
2187
|
+
data
|
|
2188
|
+
end
|
|
2189
|
+
|
|
2190
|
+
# Retrieve biometric token
|
|
2191
|
+
# Returns a biometric token's details.
|
|
2192
|
+
# @param user_id [String] Customer user ID that owns the biometric token.
|
|
2193
|
+
# @param token_uuid [String] Biometric token UUID.
|
|
2194
|
+
# @param [Hash] opts the optional parameters
|
|
2195
|
+
# @return [Array<(BiometricTokenResponse, Integer, Hash)>] BiometricTokenResponse data, response status code and response headers
|
|
2196
|
+
def find_biometric_token_with_http_info(user_id, token_uuid, opts = {})
|
|
2197
|
+
if @api_client.config.debugging
|
|
2198
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_biometric_token ...'
|
|
2199
|
+
end
|
|
2200
|
+
# verify the required parameter 'user_id' is set
|
|
2201
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
2202
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.find_biometric_token"
|
|
2203
|
+
end
|
|
2204
|
+
# verify the required parameter 'token_uuid' is set
|
|
2205
|
+
if @api_client.config.client_side_validation && token_uuid.nil?
|
|
2206
|
+
fail ArgumentError, "Missing the required parameter 'token_uuid' when calling DefaultApi.find_biometric_token"
|
|
2207
|
+
end
|
|
2208
|
+
# resource path
|
|
2209
|
+
local_var_path = '/biometric_tokens/{user_id}/{token_uuid}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'token_uuid' + '}', CGI.escape(token_uuid.to_s))
|
|
2210
|
+
|
|
2211
|
+
# query parameters
|
|
2212
|
+
query_params = opts[:query_params] || {}
|
|
2213
|
+
|
|
2214
|
+
# header parameters
|
|
2215
|
+
header_params = opts[:header_params] || {}
|
|
2216
|
+
# HTTP header 'Accept' (if needed)
|
|
2217
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2218
|
+
|
|
2219
|
+
# form parameters
|
|
2220
|
+
form_params = opts[:form_params] || {}
|
|
2221
|
+
|
|
2222
|
+
# http body (model)
|
|
2223
|
+
post_body = opts[:debug_body]
|
|
2224
|
+
|
|
2225
|
+
# return_type
|
|
2226
|
+
return_type = opts[:debug_return_type] || 'BiometricTokenResponse'
|
|
2227
|
+
|
|
2228
|
+
# auth_names
|
|
2229
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2230
|
+
|
|
2231
|
+
new_options = opts.merge(
|
|
2232
|
+
:operation => :"DefaultApi.find_biometric_token",
|
|
2233
|
+
:header_params => header_params,
|
|
2234
|
+
:query_params => query_params,
|
|
2235
|
+
:form_params => form_params,
|
|
2236
|
+
:body => post_body,
|
|
2237
|
+
:auth_names => auth_names,
|
|
2238
|
+
:return_type => return_type
|
|
2239
|
+
)
|
|
2240
|
+
|
|
2241
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2242
|
+
if @api_client.config.debugging
|
|
2243
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_biometric_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2244
|
+
end
|
|
2245
|
+
return data, status_code, headers
|
|
2246
|
+
end
|
|
2247
|
+
|
|
1913
2248
|
# Retrieve a Check
|
|
1914
2249
|
# Retrieves a single check. Returns a check object.
|
|
1915
2250
|
# @param check_id [String]
|
|
@@ -1954,7 +2289,7 @@ module Onfido
|
|
|
1954
2289
|
return_type = opts[:debug_return_type] || 'Check'
|
|
1955
2290
|
|
|
1956
2291
|
# auth_names
|
|
1957
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
2292
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
1958
2293
|
|
|
1959
2294
|
new_options = opts.merge(
|
|
1960
2295
|
:operation => :"DefaultApi.find_check",
|
|
@@ -2017,7 +2352,7 @@ module Onfido
|
|
|
2017
2352
|
return_type = opts[:debug_return_type] || 'Document'
|
|
2018
2353
|
|
|
2019
2354
|
# auth_names
|
|
2020
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
2355
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2021
2356
|
|
|
2022
2357
|
new_options = opts.merge(
|
|
2023
2358
|
:operation => :"DefaultApi.find_document",
|
|
@@ -2080,7 +2415,7 @@ module Onfido
|
|
|
2080
2415
|
return_type = opts[:debug_return_type] || 'IdPhoto'
|
|
2081
2416
|
|
|
2082
2417
|
# auth_names
|
|
2083
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
2418
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2084
2419
|
|
|
2085
2420
|
new_options = opts.merge(
|
|
2086
2421
|
:operation => :"DefaultApi.find_id_photo",
|
|
@@ -2143,7 +2478,7 @@ module Onfido
|
|
|
2143
2478
|
return_type = opts[:debug_return_type] || 'LivePhoto'
|
|
2144
2479
|
|
|
2145
2480
|
# auth_names
|
|
2146
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
2481
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2147
2482
|
|
|
2148
2483
|
new_options = opts.merge(
|
|
2149
2484
|
:operation => :"DefaultApi.find_live_photo",
|
|
@@ -2206,7 +2541,7 @@ module Onfido
|
|
|
2206
2541
|
return_type = opts[:debug_return_type] || 'LiveVideo'
|
|
2207
2542
|
|
|
2208
2543
|
# auth_names
|
|
2209
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
2544
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2210
2545
|
|
|
2211
2546
|
new_options = opts.merge(
|
|
2212
2547
|
:operation => :"DefaultApi.find_live_video",
|
|
@@ -2269,7 +2604,7 @@ module Onfido
|
|
|
2269
2604
|
return_type = opts[:debug_return_type] || 'MotionCapture'
|
|
2270
2605
|
|
|
2271
2606
|
# auth_names
|
|
2272
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
2607
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2273
2608
|
|
|
2274
2609
|
new_options = opts.merge(
|
|
2275
2610
|
:operation => :"DefaultApi.find_motion_capture",
|
|
@@ -2288,24 +2623,93 @@ module Onfido
|
|
|
2288
2623
|
return data, status_code, headers
|
|
2289
2624
|
end
|
|
2290
2625
|
|
|
2291
|
-
# Retrieve
|
|
2292
|
-
#
|
|
2293
|
-
# @param
|
|
2626
|
+
# Retrieve passkey
|
|
2627
|
+
# Returns a passkey's details.
|
|
2628
|
+
# @param username [String] Username that owns the passkey.
|
|
2629
|
+
# @param passkey_id [String] Passkey ID.
|
|
2294
2630
|
# @param [Hash] opts the optional parameters
|
|
2295
|
-
# @return [
|
|
2296
|
-
def
|
|
2297
|
-
data, _status_code, _headers =
|
|
2631
|
+
# @return [Passkey]
|
|
2632
|
+
def find_passkey(username, passkey_id, opts = {})
|
|
2633
|
+
data, _status_code, _headers = find_passkey_with_http_info(username, passkey_id, opts)
|
|
2298
2634
|
data
|
|
2299
2635
|
end
|
|
2300
2636
|
|
|
2301
|
-
# Retrieve
|
|
2302
|
-
#
|
|
2303
|
-
# @param
|
|
2637
|
+
# Retrieve passkey
|
|
2638
|
+
# Returns a passkey's details.
|
|
2639
|
+
# @param username [String] Username that owns the passkey.
|
|
2640
|
+
# @param passkey_id [String] Passkey ID.
|
|
2304
2641
|
# @param [Hash] opts the optional parameters
|
|
2305
|
-
# @return [Array<(
|
|
2306
|
-
def
|
|
2642
|
+
# @return [Array<(Passkey, Integer, Hash)>] Passkey data, response status code and response headers
|
|
2643
|
+
def find_passkey_with_http_info(username, passkey_id, opts = {})
|
|
2307
2644
|
if @api_client.config.debugging
|
|
2308
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.
|
|
2645
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_passkey ...'
|
|
2646
|
+
end
|
|
2647
|
+
# verify the required parameter 'username' is set
|
|
2648
|
+
if @api_client.config.client_side_validation && username.nil?
|
|
2649
|
+
fail ArgumentError, "Missing the required parameter 'username' when calling DefaultApi.find_passkey"
|
|
2650
|
+
end
|
|
2651
|
+
# verify the required parameter 'passkey_id' is set
|
|
2652
|
+
if @api_client.config.client_side_validation && passkey_id.nil?
|
|
2653
|
+
fail ArgumentError, "Missing the required parameter 'passkey_id' when calling DefaultApi.find_passkey"
|
|
2654
|
+
end
|
|
2655
|
+
# resource path
|
|
2656
|
+
local_var_path = '/passkeys/{username}/{passkey_id}'.sub('{' + 'username' + '}', CGI.escape(username.to_s)).sub('{' + 'passkey_id' + '}', CGI.escape(passkey_id.to_s))
|
|
2657
|
+
|
|
2658
|
+
# query parameters
|
|
2659
|
+
query_params = opts[:query_params] || {}
|
|
2660
|
+
|
|
2661
|
+
# header parameters
|
|
2662
|
+
header_params = opts[:header_params] || {}
|
|
2663
|
+
# HTTP header 'Accept' (if needed)
|
|
2664
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2665
|
+
|
|
2666
|
+
# form parameters
|
|
2667
|
+
form_params = opts[:form_params] || {}
|
|
2668
|
+
|
|
2669
|
+
# http body (model)
|
|
2670
|
+
post_body = opts[:debug_body]
|
|
2671
|
+
|
|
2672
|
+
# return_type
|
|
2673
|
+
return_type = opts[:debug_return_type] || 'Passkey'
|
|
2674
|
+
|
|
2675
|
+
# auth_names
|
|
2676
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2677
|
+
|
|
2678
|
+
new_options = opts.merge(
|
|
2679
|
+
:operation => :"DefaultApi.find_passkey",
|
|
2680
|
+
:header_params => header_params,
|
|
2681
|
+
:query_params => query_params,
|
|
2682
|
+
:form_params => form_params,
|
|
2683
|
+
:body => post_body,
|
|
2684
|
+
:auth_names => auth_names,
|
|
2685
|
+
:return_type => return_type
|
|
2686
|
+
)
|
|
2687
|
+
|
|
2688
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2689
|
+
if @api_client.config.debugging
|
|
2690
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_passkey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2691
|
+
end
|
|
2692
|
+
return data, status_code, headers
|
|
2693
|
+
end
|
|
2694
|
+
|
|
2695
|
+
# Retrieve report
|
|
2696
|
+
# A single report can be retrieved using this endpoint with the corresponding unique identifier.
|
|
2697
|
+
# @param report_id [String]
|
|
2698
|
+
# @param [Hash] opts the optional parameters
|
|
2699
|
+
# @return [Report]
|
|
2700
|
+
def find_report(report_id, opts = {})
|
|
2701
|
+
data, _status_code, _headers = find_report_with_http_info(report_id, opts)
|
|
2702
|
+
data
|
|
2703
|
+
end
|
|
2704
|
+
|
|
2705
|
+
# Retrieve report
|
|
2706
|
+
# A single report can be retrieved using this endpoint with the corresponding unique identifier.
|
|
2707
|
+
# @param report_id [String]
|
|
2708
|
+
# @param [Hash] opts the optional parameters
|
|
2709
|
+
# @return [Array<(Report, Integer, Hash)>] Report data, response status code and response headers
|
|
2710
|
+
def find_report_with_http_info(report_id, opts = {})
|
|
2711
|
+
if @api_client.config.debugging
|
|
2712
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_report ...'
|
|
2309
2713
|
end
|
|
2310
2714
|
# verify the required parameter 'report_id' is set
|
|
2311
2715
|
if @api_client.config.client_side_validation && report_id.nil?
|
|
@@ -2332,7 +2736,7 @@ module Onfido
|
|
|
2332
2736
|
return_type = opts[:debug_return_type] || 'Report'
|
|
2333
2737
|
|
|
2334
2738
|
# auth_names
|
|
2335
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
2739
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2336
2740
|
|
|
2337
2741
|
new_options = opts.merge(
|
|
2338
2742
|
:operation => :"DefaultApi.find_report",
|
|
@@ -2351,6 +2755,69 @@ module Onfido
|
|
|
2351
2755
|
return data, status_code, headers
|
|
2352
2756
|
end
|
|
2353
2757
|
|
|
2758
|
+
# Retrieve signing document
|
|
2759
|
+
# A single signing document can be retrieved by calling this endpoint with the signing document's unique identifier.
|
|
2760
|
+
# @param signing_document_id [String]
|
|
2761
|
+
# @param [Hash] opts the optional parameters
|
|
2762
|
+
# @return [SigningDocument]
|
|
2763
|
+
def find_signing_document(signing_document_id, opts = {})
|
|
2764
|
+
data, _status_code, _headers = find_signing_document_with_http_info(signing_document_id, opts)
|
|
2765
|
+
data
|
|
2766
|
+
end
|
|
2767
|
+
|
|
2768
|
+
# Retrieve signing document
|
|
2769
|
+
# A single signing document can be retrieved by calling this endpoint with the signing document's unique identifier.
|
|
2770
|
+
# @param signing_document_id [String]
|
|
2771
|
+
# @param [Hash] opts the optional parameters
|
|
2772
|
+
# @return [Array<(SigningDocument, Integer, Hash)>] SigningDocument data, response status code and response headers
|
|
2773
|
+
def find_signing_document_with_http_info(signing_document_id, opts = {})
|
|
2774
|
+
if @api_client.config.debugging
|
|
2775
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_signing_document ...'
|
|
2776
|
+
end
|
|
2777
|
+
# verify the required parameter 'signing_document_id' is set
|
|
2778
|
+
if @api_client.config.client_side_validation && signing_document_id.nil?
|
|
2779
|
+
fail ArgumentError, "Missing the required parameter 'signing_document_id' when calling DefaultApi.find_signing_document"
|
|
2780
|
+
end
|
|
2781
|
+
# resource path
|
|
2782
|
+
local_var_path = '/signing_documents/{signing_document_id}'.sub('{' + 'signing_document_id' + '}', CGI.escape(signing_document_id.to_s))
|
|
2783
|
+
|
|
2784
|
+
# query parameters
|
|
2785
|
+
query_params = opts[:query_params] || {}
|
|
2786
|
+
|
|
2787
|
+
# header parameters
|
|
2788
|
+
header_params = opts[:header_params] || {}
|
|
2789
|
+
# HTTP header 'Accept' (if needed)
|
|
2790
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2791
|
+
|
|
2792
|
+
# form parameters
|
|
2793
|
+
form_params = opts[:form_params] || {}
|
|
2794
|
+
|
|
2795
|
+
# http body (model)
|
|
2796
|
+
post_body = opts[:debug_body]
|
|
2797
|
+
|
|
2798
|
+
# return_type
|
|
2799
|
+
return_type = opts[:debug_return_type] || 'SigningDocument'
|
|
2800
|
+
|
|
2801
|
+
# auth_names
|
|
2802
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2803
|
+
|
|
2804
|
+
new_options = opts.merge(
|
|
2805
|
+
:operation => :"DefaultApi.find_signing_document",
|
|
2806
|
+
:header_params => header_params,
|
|
2807
|
+
:query_params => query_params,
|
|
2808
|
+
:form_params => form_params,
|
|
2809
|
+
:body => post_body,
|
|
2810
|
+
:auth_names => auth_names,
|
|
2811
|
+
:return_type => return_type
|
|
2812
|
+
)
|
|
2813
|
+
|
|
2814
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2815
|
+
if @api_client.config.debugging
|
|
2816
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_signing_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2817
|
+
end
|
|
2818
|
+
return data, status_code, headers
|
|
2819
|
+
end
|
|
2820
|
+
|
|
2354
2821
|
# Retrieve Task
|
|
2355
2822
|
# A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
|
|
2356
2823
|
# @param workflow_run_id [String] The unique identifier of the Workflow Run to which the Task belongs.
|
|
@@ -2401,7 +2868,7 @@ module Onfido
|
|
|
2401
2868
|
return_type = opts[:debug_return_type] || 'Task'
|
|
2402
2869
|
|
|
2403
2870
|
# auth_names
|
|
2404
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
2871
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2405
2872
|
|
|
2406
2873
|
new_options = opts.merge(
|
|
2407
2874
|
:operation => :"DefaultApi.find_task",
|
|
@@ -2470,7 +2937,7 @@ module Onfido
|
|
|
2470
2937
|
return_type = opts[:debug_return_type] || 'File'
|
|
2471
2938
|
|
|
2472
2939
|
# auth_names
|
|
2473
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
2940
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2474
2941
|
|
|
2475
2942
|
new_options = opts.merge(
|
|
2476
2943
|
:operation => :"DefaultApi.find_timeline_file",
|
|
@@ -2533,7 +3000,7 @@ module Onfido
|
|
|
2533
3000
|
return_type = opts[:debug_return_type] || 'WatchlistMonitor'
|
|
2534
3001
|
|
|
2535
3002
|
# auth_names
|
|
2536
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
3003
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2537
3004
|
|
|
2538
3005
|
new_options = opts.merge(
|
|
2539
3006
|
:operation => :"DefaultApi.find_watchlist_monitor",
|
|
@@ -2596,7 +3063,7 @@ module Onfido
|
|
|
2596
3063
|
return_type = opts[:debug_return_type] || 'Webhook'
|
|
2597
3064
|
|
|
2598
3065
|
# auth_names
|
|
2599
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
3066
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2600
3067
|
|
|
2601
3068
|
new_options = opts.merge(
|
|
2602
3069
|
:operation => :"DefaultApi.find_webhook",
|
|
@@ -2659,7 +3126,7 @@ module Onfido
|
|
|
2659
3126
|
return_type = opts[:debug_return_type] || 'WorkflowRun'
|
|
2660
3127
|
|
|
2661
3128
|
# auth_names
|
|
2662
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
3129
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2663
3130
|
|
|
2664
3131
|
new_options = opts.merge(
|
|
2665
3132
|
:operation => :"DefaultApi.find_workflow_run",
|
|
@@ -2722,7 +3189,7 @@ module Onfido
|
|
|
2722
3189
|
return_type = opts[:debug_return_type]
|
|
2723
3190
|
|
|
2724
3191
|
# auth_names
|
|
2725
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
3192
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2726
3193
|
|
|
2727
3194
|
new_options = opts.merge(
|
|
2728
3195
|
:operation => :"DefaultApi.force_report_creation_from_watchlist_monitor",
|
|
@@ -2790,7 +3257,7 @@ module Onfido
|
|
|
2790
3257
|
return_type = opts[:debug_return_type] || 'SdkToken'
|
|
2791
3258
|
|
|
2792
3259
|
# auth_names
|
|
2793
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
3260
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2794
3261
|
|
|
2795
3262
|
new_options = opts.merge(
|
|
2796
3263
|
:operation => :"DefaultApi.generate_sdk_token",
|
|
@@ -2809,6 +3276,138 @@ module Onfido
|
|
|
2809
3276
|
return data, status_code, headers
|
|
2810
3277
|
end
|
|
2811
3278
|
|
|
3279
|
+
# Invalidate biometric token
|
|
3280
|
+
# Invalidates a biometric token.
|
|
3281
|
+
# @param user_id [String] Customer user ID that owns the biometric token.
|
|
3282
|
+
# @param token_uuid [String] Biometric token UUID.
|
|
3283
|
+
# @param [Hash] opts the optional parameters
|
|
3284
|
+
# @return [InvalidatedBiometricTokenResponse]
|
|
3285
|
+
def invalidate_biometric_token(user_id, token_uuid, opts = {})
|
|
3286
|
+
data, _status_code, _headers = invalidate_biometric_token_with_http_info(user_id, token_uuid, opts)
|
|
3287
|
+
data
|
|
3288
|
+
end
|
|
3289
|
+
|
|
3290
|
+
# Invalidate biometric token
|
|
3291
|
+
# Invalidates a biometric token.
|
|
3292
|
+
# @param user_id [String] Customer user ID that owns the biometric token.
|
|
3293
|
+
# @param token_uuid [String] Biometric token UUID.
|
|
3294
|
+
# @param [Hash] opts the optional parameters
|
|
3295
|
+
# @return [Array<(InvalidatedBiometricTokenResponse, Integer, Hash)>] InvalidatedBiometricTokenResponse data, response status code and response headers
|
|
3296
|
+
def invalidate_biometric_token_with_http_info(user_id, token_uuid, opts = {})
|
|
3297
|
+
if @api_client.config.debugging
|
|
3298
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.invalidate_biometric_token ...'
|
|
3299
|
+
end
|
|
3300
|
+
# verify the required parameter 'user_id' is set
|
|
3301
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
3302
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.invalidate_biometric_token"
|
|
3303
|
+
end
|
|
3304
|
+
# verify the required parameter 'token_uuid' is set
|
|
3305
|
+
if @api_client.config.client_side_validation && token_uuid.nil?
|
|
3306
|
+
fail ArgumentError, "Missing the required parameter 'token_uuid' when calling DefaultApi.invalidate_biometric_token"
|
|
3307
|
+
end
|
|
3308
|
+
# resource path
|
|
3309
|
+
local_var_path = '/biometric_tokens/{user_id}/{token_uuid}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'token_uuid' + '}', CGI.escape(token_uuid.to_s))
|
|
3310
|
+
|
|
3311
|
+
# query parameters
|
|
3312
|
+
query_params = opts[:query_params] || {}
|
|
3313
|
+
|
|
3314
|
+
# header parameters
|
|
3315
|
+
header_params = opts[:header_params] || {}
|
|
3316
|
+
# HTTP header 'Accept' (if needed)
|
|
3317
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
3318
|
+
|
|
3319
|
+
# form parameters
|
|
3320
|
+
form_params = opts[:form_params] || {}
|
|
3321
|
+
|
|
3322
|
+
# http body (model)
|
|
3323
|
+
post_body = opts[:debug_body]
|
|
3324
|
+
|
|
3325
|
+
# return_type
|
|
3326
|
+
return_type = opts[:debug_return_type] || 'InvalidatedBiometricTokenResponse'
|
|
3327
|
+
|
|
3328
|
+
# auth_names
|
|
3329
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3330
|
+
|
|
3331
|
+
new_options = opts.merge(
|
|
3332
|
+
:operation => :"DefaultApi.invalidate_biometric_token",
|
|
3333
|
+
:header_params => header_params,
|
|
3334
|
+
:query_params => query_params,
|
|
3335
|
+
:form_params => form_params,
|
|
3336
|
+
:body => post_body,
|
|
3337
|
+
:auth_names => auth_names,
|
|
3338
|
+
:return_type => return_type
|
|
3339
|
+
)
|
|
3340
|
+
|
|
3341
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
3342
|
+
if @api_client.config.debugging
|
|
3343
|
+
@api_client.config.logger.debug "API called: DefaultApi#invalidate_biometric_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3344
|
+
end
|
|
3345
|
+
return data, status_code, headers
|
|
3346
|
+
end
|
|
3347
|
+
|
|
3348
|
+
# Invalidate biometric tokens
|
|
3349
|
+
# Invalidates every biometric token associated with the supplied customer user ID.
|
|
3350
|
+
# @param user_id [String] Customer user ID whose biometric tokens will be invalidated.
|
|
3351
|
+
# @param [Hash] opts the optional parameters
|
|
3352
|
+
# @return [InvalidatedBiometricTokensResponse]
|
|
3353
|
+
def invalidate_biometric_tokens(user_id, opts = {})
|
|
3354
|
+
data, _status_code, _headers = invalidate_biometric_tokens_with_http_info(user_id, opts)
|
|
3355
|
+
data
|
|
3356
|
+
end
|
|
3357
|
+
|
|
3358
|
+
# Invalidate biometric tokens
|
|
3359
|
+
# Invalidates every biometric token associated with the supplied customer user ID.
|
|
3360
|
+
# @param user_id [String] Customer user ID whose biometric tokens will be invalidated.
|
|
3361
|
+
# @param [Hash] opts the optional parameters
|
|
3362
|
+
# @return [Array<(InvalidatedBiometricTokensResponse, Integer, Hash)>] InvalidatedBiometricTokensResponse data, response status code and response headers
|
|
3363
|
+
def invalidate_biometric_tokens_with_http_info(user_id, opts = {})
|
|
3364
|
+
if @api_client.config.debugging
|
|
3365
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.invalidate_biometric_tokens ...'
|
|
3366
|
+
end
|
|
3367
|
+
# verify the required parameter 'user_id' is set
|
|
3368
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
3369
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.invalidate_biometric_tokens"
|
|
3370
|
+
end
|
|
3371
|
+
# resource path
|
|
3372
|
+
local_var_path = '/biometric_tokens/{user_id}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))
|
|
3373
|
+
|
|
3374
|
+
# query parameters
|
|
3375
|
+
query_params = opts[:query_params] || {}
|
|
3376
|
+
|
|
3377
|
+
# header parameters
|
|
3378
|
+
header_params = opts[:header_params] || {}
|
|
3379
|
+
# HTTP header 'Accept' (if needed)
|
|
3380
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
3381
|
+
|
|
3382
|
+
# form parameters
|
|
3383
|
+
form_params = opts[:form_params] || {}
|
|
3384
|
+
|
|
3385
|
+
# http body (model)
|
|
3386
|
+
post_body = opts[:debug_body]
|
|
3387
|
+
|
|
3388
|
+
# return_type
|
|
3389
|
+
return_type = opts[:debug_return_type] || 'InvalidatedBiometricTokensResponse'
|
|
3390
|
+
|
|
3391
|
+
# auth_names
|
|
3392
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3393
|
+
|
|
3394
|
+
new_options = opts.merge(
|
|
3395
|
+
:operation => :"DefaultApi.invalidate_biometric_tokens",
|
|
3396
|
+
:header_params => header_params,
|
|
3397
|
+
:query_params => query_params,
|
|
3398
|
+
:form_params => form_params,
|
|
3399
|
+
:body => post_body,
|
|
3400
|
+
:auth_names => auth_names,
|
|
3401
|
+
:return_type => return_type
|
|
3402
|
+
)
|
|
3403
|
+
|
|
3404
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
3405
|
+
if @api_client.config.debugging
|
|
3406
|
+
@api_client.config.logger.debug "API called: DefaultApi#invalidate_biometric_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3407
|
+
end
|
|
3408
|
+
return data, status_code, headers
|
|
3409
|
+
end
|
|
3410
|
+
|
|
2812
3411
|
# List Applicants
|
|
2813
3412
|
# Lists all applicants you've created, sorted by creation date in descending order.
|
|
2814
3413
|
# @param [Hash] opts the optional parameters
|
|
@@ -2856,7 +3455,7 @@ module Onfido
|
|
|
2856
3455
|
return_type = opts[:debug_return_type] || 'ApplicantsList'
|
|
2857
3456
|
|
|
2858
3457
|
# auth_names
|
|
2859
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
3458
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2860
3459
|
|
|
2861
3460
|
new_options = opts.merge(
|
|
2862
3461
|
:operation => :"DefaultApi.list_applicants",
|
|
@@ -2875,6 +3474,69 @@ module Onfido
|
|
|
2875
3474
|
return data, status_code, headers
|
|
2876
3475
|
end
|
|
2877
3476
|
|
|
3477
|
+
# List biometric tokens
|
|
3478
|
+
# Returns the biometric tokens associated with the supplied customer user ID.
|
|
3479
|
+
# @param user_id [String] Customer user ID that owns the biometric tokens.
|
|
3480
|
+
# @param [Hash] opts the optional parameters
|
|
3481
|
+
# @return [BiometricTokensResponse]
|
|
3482
|
+
def list_biometric_tokens(user_id, opts = {})
|
|
3483
|
+
data, _status_code, _headers = list_biometric_tokens_with_http_info(user_id, opts)
|
|
3484
|
+
data
|
|
3485
|
+
end
|
|
3486
|
+
|
|
3487
|
+
# List biometric tokens
|
|
3488
|
+
# Returns the biometric tokens associated with the supplied customer user ID.
|
|
3489
|
+
# @param user_id [String] Customer user ID that owns the biometric tokens.
|
|
3490
|
+
# @param [Hash] opts the optional parameters
|
|
3491
|
+
# @return [Array<(BiometricTokensResponse, Integer, Hash)>] BiometricTokensResponse data, response status code and response headers
|
|
3492
|
+
def list_biometric_tokens_with_http_info(user_id, opts = {})
|
|
3493
|
+
if @api_client.config.debugging
|
|
3494
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_biometric_tokens ...'
|
|
3495
|
+
end
|
|
3496
|
+
# verify the required parameter 'user_id' is set
|
|
3497
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
3498
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.list_biometric_tokens"
|
|
3499
|
+
end
|
|
3500
|
+
# resource path
|
|
3501
|
+
local_var_path = '/biometric_tokens/{user_id}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))
|
|
3502
|
+
|
|
3503
|
+
# query parameters
|
|
3504
|
+
query_params = opts[:query_params] || {}
|
|
3505
|
+
|
|
3506
|
+
# header parameters
|
|
3507
|
+
header_params = opts[:header_params] || {}
|
|
3508
|
+
# HTTP header 'Accept' (if needed)
|
|
3509
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
3510
|
+
|
|
3511
|
+
# form parameters
|
|
3512
|
+
form_params = opts[:form_params] || {}
|
|
3513
|
+
|
|
3514
|
+
# http body (model)
|
|
3515
|
+
post_body = opts[:debug_body]
|
|
3516
|
+
|
|
3517
|
+
# return_type
|
|
3518
|
+
return_type = opts[:debug_return_type] || 'BiometricTokensResponse'
|
|
3519
|
+
|
|
3520
|
+
# auth_names
|
|
3521
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3522
|
+
|
|
3523
|
+
new_options = opts.merge(
|
|
3524
|
+
:operation => :"DefaultApi.list_biometric_tokens",
|
|
3525
|
+
:header_params => header_params,
|
|
3526
|
+
:query_params => query_params,
|
|
3527
|
+
:form_params => form_params,
|
|
3528
|
+
:body => post_body,
|
|
3529
|
+
:auth_names => auth_names,
|
|
3530
|
+
:return_type => return_type
|
|
3531
|
+
)
|
|
3532
|
+
|
|
3533
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3534
|
+
if @api_client.config.debugging
|
|
3535
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_biometric_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3536
|
+
end
|
|
3537
|
+
return data, status_code, headers
|
|
3538
|
+
end
|
|
3539
|
+
|
|
2878
3540
|
# Retrieve Checks
|
|
2879
3541
|
# Retrieves a single check. Returns a check object.
|
|
2880
3542
|
# @param applicant_id [String]
|
|
@@ -2920,7 +3582,7 @@ module Onfido
|
|
|
2920
3582
|
return_type = opts[:debug_return_type] || 'ChecksList'
|
|
2921
3583
|
|
|
2922
3584
|
# auth_names
|
|
2923
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
3585
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2924
3586
|
|
|
2925
3587
|
new_options = opts.merge(
|
|
2926
3588
|
:operation => :"DefaultApi.list_checks",
|
|
@@ -2984,7 +3646,7 @@ module Onfido
|
|
|
2984
3646
|
return_type = opts[:debug_return_type] || 'DocumentsList'
|
|
2985
3647
|
|
|
2986
3648
|
# auth_names
|
|
2987
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
3649
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
2988
3650
|
|
|
2989
3651
|
new_options = opts.merge(
|
|
2990
3652
|
:operation => :"DefaultApi.list_documents",
|
|
@@ -3048,7 +3710,7 @@ module Onfido
|
|
|
3048
3710
|
return_type = opts[:debug_return_type] || 'IdPhotosList'
|
|
3049
3711
|
|
|
3050
3712
|
# auth_names
|
|
3051
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
3713
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3052
3714
|
|
|
3053
3715
|
new_options = opts.merge(
|
|
3054
3716
|
:operation => :"DefaultApi.list_id_photos",
|
|
@@ -3112,7 +3774,7 @@ module Onfido
|
|
|
3112
3774
|
return_type = opts[:debug_return_type] || 'LivePhotosList'
|
|
3113
3775
|
|
|
3114
3776
|
# auth_names
|
|
3115
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
3777
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3116
3778
|
|
|
3117
3779
|
new_options = opts.merge(
|
|
3118
3780
|
:operation => :"DefaultApi.list_live_photos",
|
|
@@ -3176,7 +3838,7 @@ module Onfido
|
|
|
3176
3838
|
return_type = opts[:debug_return_type] || 'LiveVideosList'
|
|
3177
3839
|
|
|
3178
3840
|
# auth_names
|
|
3179
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
3841
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3180
3842
|
|
|
3181
3843
|
new_options = opts.merge(
|
|
3182
3844
|
:operation => :"DefaultApi.list_live_videos",
|
|
@@ -3214,16 +3876,79 @@ module Onfido
|
|
|
3214
3876
|
if @api_client.config.debugging
|
|
3215
3877
|
@api_client.config.logger.debug 'Calling API: DefaultApi.list_motion_captures ...'
|
|
3216
3878
|
end
|
|
3217
|
-
# verify the required parameter 'applicant_id' is set
|
|
3218
|
-
if @api_client.config.client_side_validation && applicant_id.nil?
|
|
3219
|
-
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.list_motion_captures"
|
|
3879
|
+
# verify the required parameter 'applicant_id' is set
|
|
3880
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
|
3881
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.list_motion_captures"
|
|
3882
|
+
end
|
|
3883
|
+
# resource path
|
|
3884
|
+
local_var_path = '/motion_captures'
|
|
3885
|
+
|
|
3886
|
+
# query parameters
|
|
3887
|
+
query_params = opts[:query_params] || {}
|
|
3888
|
+
query_params[:'applicant_id'] = applicant_id
|
|
3889
|
+
|
|
3890
|
+
# header parameters
|
|
3891
|
+
header_params = opts[:header_params] || {}
|
|
3892
|
+
# HTTP header 'Accept' (if needed)
|
|
3893
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
3894
|
+
|
|
3895
|
+
# form parameters
|
|
3896
|
+
form_params = opts[:form_params] || {}
|
|
3897
|
+
|
|
3898
|
+
# http body (model)
|
|
3899
|
+
post_body = opts[:debug_body]
|
|
3900
|
+
|
|
3901
|
+
# return_type
|
|
3902
|
+
return_type = opts[:debug_return_type] || 'MotionCapturesList'
|
|
3903
|
+
|
|
3904
|
+
# auth_names
|
|
3905
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3906
|
+
|
|
3907
|
+
new_options = opts.merge(
|
|
3908
|
+
:operation => :"DefaultApi.list_motion_captures",
|
|
3909
|
+
:header_params => header_params,
|
|
3910
|
+
:query_params => query_params,
|
|
3911
|
+
:form_params => form_params,
|
|
3912
|
+
:body => post_body,
|
|
3913
|
+
:auth_names => auth_names,
|
|
3914
|
+
:return_type => return_type
|
|
3915
|
+
)
|
|
3916
|
+
|
|
3917
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3918
|
+
if @api_client.config.debugging
|
|
3919
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_motion_captures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3920
|
+
end
|
|
3921
|
+
return data, status_code, headers
|
|
3922
|
+
end
|
|
3923
|
+
|
|
3924
|
+
# List passkeys
|
|
3925
|
+
# Returns every passkey registered under the supplied username.
|
|
3926
|
+
# @param username [String] Username that owns the passkeys.
|
|
3927
|
+
# @param [Hash] opts the optional parameters
|
|
3928
|
+
# @return [PasskeysList]
|
|
3929
|
+
def list_passkeys(username, opts = {})
|
|
3930
|
+
data, _status_code, _headers = list_passkeys_with_http_info(username, opts)
|
|
3931
|
+
data
|
|
3932
|
+
end
|
|
3933
|
+
|
|
3934
|
+
# List passkeys
|
|
3935
|
+
# Returns every passkey registered under the supplied username.
|
|
3936
|
+
# @param username [String] Username that owns the passkeys.
|
|
3937
|
+
# @param [Hash] opts the optional parameters
|
|
3938
|
+
# @return [Array<(PasskeysList, Integer, Hash)>] PasskeysList data, response status code and response headers
|
|
3939
|
+
def list_passkeys_with_http_info(username, opts = {})
|
|
3940
|
+
if @api_client.config.debugging
|
|
3941
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_passkeys ...'
|
|
3942
|
+
end
|
|
3943
|
+
# verify the required parameter 'username' is set
|
|
3944
|
+
if @api_client.config.client_side_validation && username.nil?
|
|
3945
|
+
fail ArgumentError, "Missing the required parameter 'username' when calling DefaultApi.list_passkeys"
|
|
3220
3946
|
end
|
|
3221
3947
|
# resource path
|
|
3222
|
-
local_var_path = '/
|
|
3948
|
+
local_var_path = '/passkeys/{username}'.sub('{' + 'username' + '}', CGI.escape(username.to_s))
|
|
3223
3949
|
|
|
3224
3950
|
# query parameters
|
|
3225
3951
|
query_params = opts[:query_params] || {}
|
|
3226
|
-
query_params[:'applicant_id'] = applicant_id
|
|
3227
3952
|
|
|
3228
3953
|
# header parameters
|
|
3229
3954
|
header_params = opts[:header_params] || {}
|
|
@@ -3237,13 +3962,13 @@ module Onfido
|
|
|
3237
3962
|
post_body = opts[:debug_body]
|
|
3238
3963
|
|
|
3239
3964
|
# return_type
|
|
3240
|
-
return_type = opts[:debug_return_type] || '
|
|
3965
|
+
return_type = opts[:debug_return_type] || 'PasskeysList'
|
|
3241
3966
|
|
|
3242
3967
|
# auth_names
|
|
3243
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
3968
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3244
3969
|
|
|
3245
3970
|
new_options = opts.merge(
|
|
3246
|
-
:operation => :"DefaultApi.
|
|
3971
|
+
:operation => :"DefaultApi.list_passkeys",
|
|
3247
3972
|
:header_params => header_params,
|
|
3248
3973
|
:query_params => query_params,
|
|
3249
3974
|
:form_params => form_params,
|
|
@@ -3254,7 +3979,7 @@ module Onfido
|
|
|
3254
3979
|
|
|
3255
3980
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3256
3981
|
if @api_client.config.debugging
|
|
3257
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
|
3982
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_passkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3258
3983
|
end
|
|
3259
3984
|
return data, status_code, headers
|
|
3260
3985
|
end
|
|
@@ -3303,7 +4028,7 @@ module Onfido
|
|
|
3303
4028
|
return_type = opts[:debug_return_type] || 'RepeatAttemptsList'
|
|
3304
4029
|
|
|
3305
4030
|
# auth_names
|
|
3306
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4031
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3307
4032
|
|
|
3308
4033
|
new_options = opts.merge(
|
|
3309
4034
|
:operation => :"DefaultApi.list_repeat_attempts",
|
|
@@ -3367,7 +4092,7 @@ module Onfido
|
|
|
3367
4092
|
return_type = opts[:debug_return_type] || 'ReportsList'
|
|
3368
4093
|
|
|
3369
4094
|
# auth_names
|
|
3370
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4095
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3371
4096
|
|
|
3372
4097
|
new_options = opts.merge(
|
|
3373
4098
|
:operation => :"DefaultApi.list_reports",
|
|
@@ -3386,6 +4111,70 @@ module Onfido
|
|
|
3386
4111
|
return data, status_code, headers
|
|
3387
4112
|
end
|
|
3388
4113
|
|
|
4114
|
+
# List signing documents
|
|
4115
|
+
# All signing documents belonging to an applicant can be listed from this endpoint
|
|
4116
|
+
# @param applicant_id [String]
|
|
4117
|
+
# @param [Hash] opts the optional parameters
|
|
4118
|
+
# @return [SigningDocumentsList]
|
|
4119
|
+
def list_signing_documents(applicant_id, opts = {})
|
|
4120
|
+
data, _status_code, _headers = list_signing_documents_with_http_info(applicant_id, opts)
|
|
4121
|
+
data
|
|
4122
|
+
end
|
|
4123
|
+
|
|
4124
|
+
# List signing documents
|
|
4125
|
+
# All signing documents belonging to an applicant can be listed from this endpoint
|
|
4126
|
+
# @param applicant_id [String]
|
|
4127
|
+
# @param [Hash] opts the optional parameters
|
|
4128
|
+
# @return [Array<(SigningDocumentsList, Integer, Hash)>] SigningDocumentsList data, response status code and response headers
|
|
4129
|
+
def list_signing_documents_with_http_info(applicant_id, opts = {})
|
|
4130
|
+
if @api_client.config.debugging
|
|
4131
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_signing_documents ...'
|
|
4132
|
+
end
|
|
4133
|
+
# verify the required parameter 'applicant_id' is set
|
|
4134
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
|
4135
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.list_signing_documents"
|
|
4136
|
+
end
|
|
4137
|
+
# resource path
|
|
4138
|
+
local_var_path = '/signing_documents'
|
|
4139
|
+
|
|
4140
|
+
# query parameters
|
|
4141
|
+
query_params = opts[:query_params] || {}
|
|
4142
|
+
query_params[:'applicant_id'] = applicant_id
|
|
4143
|
+
|
|
4144
|
+
# header parameters
|
|
4145
|
+
header_params = opts[:header_params] || {}
|
|
4146
|
+
# HTTP header 'Accept' (if needed)
|
|
4147
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
4148
|
+
|
|
4149
|
+
# form parameters
|
|
4150
|
+
form_params = opts[:form_params] || {}
|
|
4151
|
+
|
|
4152
|
+
# http body (model)
|
|
4153
|
+
post_body = opts[:debug_body]
|
|
4154
|
+
|
|
4155
|
+
# return_type
|
|
4156
|
+
return_type = opts[:debug_return_type] || 'SigningDocumentsList'
|
|
4157
|
+
|
|
4158
|
+
# auth_names
|
|
4159
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
4160
|
+
|
|
4161
|
+
new_options = opts.merge(
|
|
4162
|
+
:operation => :"DefaultApi.list_signing_documents",
|
|
4163
|
+
:header_params => header_params,
|
|
4164
|
+
:query_params => query_params,
|
|
4165
|
+
:form_params => form_params,
|
|
4166
|
+
:body => post_body,
|
|
4167
|
+
:auth_names => auth_names,
|
|
4168
|
+
:return_type => return_type
|
|
4169
|
+
)
|
|
4170
|
+
|
|
4171
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4172
|
+
if @api_client.config.debugging
|
|
4173
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_signing_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4174
|
+
end
|
|
4175
|
+
return data, status_code, headers
|
|
4176
|
+
end
|
|
4177
|
+
|
|
3389
4178
|
# List Tasks
|
|
3390
4179
|
# The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
|
3391
4180
|
# @param workflow_run_id [String] The unique identifier of the Workflow Run to which the Tasks belong.
|
|
@@ -3430,7 +4219,7 @@ module Onfido
|
|
|
3430
4219
|
return_type = opts[:debug_return_type] || 'Array<TaskItem>'
|
|
3431
4220
|
|
|
3432
4221
|
# auth_names
|
|
3433
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4222
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3434
4223
|
|
|
3435
4224
|
new_options = opts.merge(
|
|
3436
4225
|
:operation => :"DefaultApi.list_tasks",
|
|
@@ -3449,6 +4238,75 @@ module Onfido
|
|
|
3449
4238
|
return data, status_code, headers
|
|
3450
4239
|
end
|
|
3451
4240
|
|
|
4241
|
+
# Retrieve watchlist mesh alert risks
|
|
4242
|
+
# Retrieves the detailed risks associated with a watchlist mesh alert.
|
|
4243
|
+
# @param alert_id [String] The unique identifier of the alert whose risks you want to retrieve.
|
|
4244
|
+
# @param [Hash] opts the optional parameters
|
|
4245
|
+
# @option opts [Integer] :page The page of results to retrieve. (default to 1)
|
|
4246
|
+
# @option opts [Integer] :per_page The number of risks to return per page. (default to 25)
|
|
4247
|
+
# @return [Array<WatchlistMeshAlertRisk>]
|
|
4248
|
+
def list_watchlist_mesh_alert_risks(alert_id, opts = {})
|
|
4249
|
+
data, _status_code, _headers = list_watchlist_mesh_alert_risks_with_http_info(alert_id, opts)
|
|
4250
|
+
data
|
|
4251
|
+
end
|
|
4252
|
+
|
|
4253
|
+
# Retrieve watchlist mesh alert risks
|
|
4254
|
+
# Retrieves the detailed risks associated with a watchlist mesh alert.
|
|
4255
|
+
# @param alert_id [String] The unique identifier of the alert whose risks you want to retrieve.
|
|
4256
|
+
# @param [Hash] opts the optional parameters
|
|
4257
|
+
# @option opts [Integer] :page The page of results to retrieve. (default to 1)
|
|
4258
|
+
# @option opts [Integer] :per_page The number of risks to return per page. (default to 25)
|
|
4259
|
+
# @return [Array<(Array<WatchlistMeshAlertRisk>, Integer, Hash)>] Array<WatchlistMeshAlertRisk> data, response status code and response headers
|
|
4260
|
+
def list_watchlist_mesh_alert_risks_with_http_info(alert_id, opts = {})
|
|
4261
|
+
if @api_client.config.debugging
|
|
4262
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_watchlist_mesh_alert_risks ...'
|
|
4263
|
+
end
|
|
4264
|
+
# verify the required parameter 'alert_id' is set
|
|
4265
|
+
if @api_client.config.client_side_validation && alert_id.nil?
|
|
4266
|
+
fail ArgumentError, "Missing the required parameter 'alert_id' when calling DefaultApi.list_watchlist_mesh_alert_risks"
|
|
4267
|
+
end
|
|
4268
|
+
# resource path
|
|
4269
|
+
local_var_path = '/complyadvantage_watchlists/alerts/{alert_id}/risks'.sub('{' + 'alert_id' + '}', CGI.escape(alert_id.to_s))
|
|
4270
|
+
|
|
4271
|
+
# query parameters
|
|
4272
|
+
query_params = opts[:query_params] || {}
|
|
4273
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
4274
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
|
4275
|
+
|
|
4276
|
+
# header parameters
|
|
4277
|
+
header_params = opts[:header_params] || {}
|
|
4278
|
+
# HTTP header 'Accept' (if needed)
|
|
4279
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
4280
|
+
|
|
4281
|
+
# form parameters
|
|
4282
|
+
form_params = opts[:form_params] || {}
|
|
4283
|
+
|
|
4284
|
+
# http body (model)
|
|
4285
|
+
post_body = opts[:debug_body]
|
|
4286
|
+
|
|
4287
|
+
# return_type
|
|
4288
|
+
return_type = opts[:debug_return_type] || 'Array<WatchlistMeshAlertRisk>'
|
|
4289
|
+
|
|
4290
|
+
# auth_names
|
|
4291
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
4292
|
+
|
|
4293
|
+
new_options = opts.merge(
|
|
4294
|
+
:operation => :"DefaultApi.list_watchlist_mesh_alert_risks",
|
|
4295
|
+
:header_params => header_params,
|
|
4296
|
+
:query_params => query_params,
|
|
4297
|
+
:form_params => form_params,
|
|
4298
|
+
:body => post_body,
|
|
4299
|
+
:auth_names => auth_names,
|
|
4300
|
+
:return_type => return_type
|
|
4301
|
+
)
|
|
4302
|
+
|
|
4303
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4304
|
+
if @api_client.config.debugging
|
|
4305
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_watchlist_mesh_alert_risks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4306
|
+
end
|
|
4307
|
+
return data, status_code, headers
|
|
4308
|
+
end
|
|
4309
|
+
|
|
3452
4310
|
# List matches (BETA)
|
|
3453
4311
|
# List match IDs on this monitor, as well as their enabled/disabled status
|
|
3454
4312
|
# @param monitor_id [String]
|
|
@@ -3493,7 +4351,7 @@ module Onfido
|
|
|
3493
4351
|
return_type = opts[:debug_return_type] || 'WatchlistMonitorMatchesList'
|
|
3494
4352
|
|
|
3495
4353
|
# auth_names
|
|
3496
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4354
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3497
4355
|
|
|
3498
4356
|
new_options = opts.merge(
|
|
3499
4357
|
:operation => :"DefaultApi.list_watchlist_monitor_matches",
|
|
@@ -3560,7 +4418,7 @@ module Onfido
|
|
|
3560
4418
|
return_type = opts[:debug_return_type] || 'WatchlistMonitorsList'
|
|
3561
4419
|
|
|
3562
4420
|
# auth_names
|
|
3563
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4421
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3564
4422
|
|
|
3565
4423
|
new_options = opts.merge(
|
|
3566
4424
|
:operation => :"DefaultApi.list_watchlist_monitors",
|
|
@@ -3617,7 +4475,7 @@ module Onfido
|
|
|
3617
4475
|
return_type = opts[:debug_return_type] || 'WebhooksList'
|
|
3618
4476
|
|
|
3619
4477
|
# auth_names
|
|
3620
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4478
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3621
4479
|
|
|
3622
4480
|
new_options = opts.merge(
|
|
3623
4481
|
:operation => :"DefaultApi.list_webhooks",
|
|
@@ -3641,10 +4499,11 @@ module Onfido
|
|
|
3641
4499
|
# @param [Hash] opts the optional parameters
|
|
3642
4500
|
# @option opts [Integer] :page The number of the page to be retrieved. If not specified, defaults to 1. (default to 1)
|
|
3643
4501
|
# @option opts [String] :status A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'.
|
|
3644
|
-
# @option opts [
|
|
3645
|
-
# @option opts [
|
|
4502
|
+
# @option opts [Date] :created_at_gt A ISO-8601 date to filter results with a created date greater than (after) the one provided.
|
|
4503
|
+
# @option opts [Date] :created_at_lt A ISO-8601 date to filter results with a created date less than (before) the one provided.
|
|
3646
4504
|
# @option opts [String] :sort A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. (default to 'desc')
|
|
3647
4505
|
# @option opts [String] :applicant_id the applicant's id.
|
|
4506
|
+
# @option opts [Array<String>] :tags A list of tags to filter the results.
|
|
3648
4507
|
# @return [Array<WorkflowRun>]
|
|
3649
4508
|
def list_workflow_runs(opts = {})
|
|
3650
4509
|
data, _status_code, _headers = list_workflow_runs_with_http_info(opts)
|
|
@@ -3656,10 +4515,11 @@ module Onfido
|
|
|
3656
4515
|
# @param [Hash] opts the optional parameters
|
|
3657
4516
|
# @option opts [Integer] :page The number of the page to be retrieved. If not specified, defaults to 1. (default to 1)
|
|
3658
4517
|
# @option opts [String] :status A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'.
|
|
3659
|
-
# @option opts [
|
|
3660
|
-
# @option opts [
|
|
4518
|
+
# @option opts [Date] :created_at_gt A ISO-8601 date to filter results with a created date greater than (after) the one provided.
|
|
4519
|
+
# @option opts [Date] :created_at_lt A ISO-8601 date to filter results with a created date less than (before) the one provided.
|
|
3661
4520
|
# @option opts [String] :sort A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. (default to 'desc')
|
|
3662
4521
|
# @option opts [String] :applicant_id the applicant's id.
|
|
4522
|
+
# @option opts [Array<String>] :tags A list of tags to filter the results.
|
|
3663
4523
|
# @return [Array<(Array<WorkflowRun>, Integer, Hash)>] Array<WorkflowRun> data, response status code and response headers
|
|
3664
4524
|
def list_workflow_runs_with_http_info(opts = {})
|
|
3665
4525
|
if @api_client.config.debugging
|
|
@@ -3680,6 +4540,7 @@ module Onfido
|
|
|
3680
4540
|
query_params[:'created_at_lt'] = opts[:'created_at_lt'] if !opts[:'created_at_lt'].nil?
|
|
3681
4541
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
3682
4542
|
query_params[:'applicant_id'] = opts[:'applicant_id'] if !opts[:'applicant_id'].nil?
|
|
4543
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
|
3683
4544
|
|
|
3684
4545
|
# header parameters
|
|
3685
4546
|
header_params = opts[:header_params] || {}
|
|
@@ -3696,7 +4557,7 @@ module Onfido
|
|
|
3696
4557
|
return_type = opts[:debug_return_type] || 'Array<WorkflowRun>'
|
|
3697
4558
|
|
|
3698
4559
|
# auth_names
|
|
3699
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4560
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3700
4561
|
|
|
3701
4562
|
new_options = opts.merge(
|
|
3702
4563
|
:operation => :"DefaultApi.list_workflow_runs",
|
|
@@ -3753,7 +4614,7 @@ module Onfido
|
|
|
3753
4614
|
return_type = opts[:debug_return_type] || 'String'
|
|
3754
4615
|
|
|
3755
4616
|
# auth_names
|
|
3756
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4617
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3757
4618
|
|
|
3758
4619
|
new_options = opts.merge(
|
|
3759
4620
|
:operation => :"DefaultApi.ping",
|
|
@@ -3821,7 +4682,7 @@ module Onfido
|
|
|
3821
4682
|
return_type = opts[:debug_return_type] || 'ResultsFeedback'
|
|
3822
4683
|
|
|
3823
4684
|
# auth_names
|
|
3824
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4685
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3825
4686
|
|
|
3826
4687
|
new_options = opts.merge(
|
|
3827
4688
|
:operation => :"DefaultApi.post_results_feedback",
|
|
@@ -3889,7 +4750,7 @@ module Onfido
|
|
|
3889
4750
|
return_type = opts[:debug_return_type]
|
|
3890
4751
|
|
|
3891
4752
|
# auth_names
|
|
3892
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4753
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3893
4754
|
|
|
3894
4755
|
new_options = opts.merge(
|
|
3895
4756
|
:operation => :"DefaultApi.resend_webhooks",
|
|
@@ -3952,7 +4813,7 @@ module Onfido
|
|
|
3952
4813
|
return_type = opts[:debug_return_type]
|
|
3953
4814
|
|
|
3954
4815
|
# auth_names
|
|
3955
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4816
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
3956
4817
|
|
|
3957
4818
|
new_options = opts.merge(
|
|
3958
4819
|
:operation => :"DefaultApi.restore_applicant",
|
|
@@ -4015,7 +4876,7 @@ module Onfido
|
|
|
4015
4876
|
return_type = opts[:debug_return_type]
|
|
4016
4877
|
|
|
4017
4878
|
# auth_names
|
|
4018
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4879
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
4019
4880
|
|
|
4020
4881
|
new_options = opts.merge(
|
|
4021
4882
|
:operation => :"DefaultApi.resume_check",
|
|
@@ -4078,7 +4939,7 @@ module Onfido
|
|
|
4078
4939
|
return_type = opts[:debug_return_type]
|
|
4079
4940
|
|
|
4080
4941
|
# auth_names
|
|
4081
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
4942
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
4082
4943
|
|
|
4083
4944
|
new_options = opts.merge(
|
|
4084
4945
|
:operation => :"DefaultApi.resume_report",
|
|
@@ -4152,7 +5013,7 @@ module Onfido
|
|
|
4152
5013
|
return_type = opts[:debug_return_type] || 'Applicant'
|
|
4153
5014
|
|
|
4154
5015
|
# auth_names
|
|
4155
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
5016
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
4156
5017
|
|
|
4157
5018
|
new_options = opts.merge(
|
|
4158
5019
|
:operation => :"DefaultApi.update_applicant",
|
|
@@ -4171,6 +5032,166 @@ module Onfido
|
|
|
4171
5032
|
return data, status_code, headers
|
|
4172
5033
|
end
|
|
4173
5034
|
|
|
5035
|
+
# Update biometric token
|
|
5036
|
+
# Updates a biometric token's status.
|
|
5037
|
+
# @param user_id [String] Customer user ID that owns the biometric token.
|
|
5038
|
+
# @param token_uuid [String] Biometric token UUID.
|
|
5039
|
+
# @param biometric_token_updater [BiometricTokenUpdater] Biometric token update payload.
|
|
5040
|
+
# @param [Hash] opts the optional parameters
|
|
5041
|
+
# @return [UpdatedBiometricTokenResponse]
|
|
5042
|
+
def update_biometric_token(user_id, token_uuid, biometric_token_updater, opts = {})
|
|
5043
|
+
data, _status_code, _headers = update_biometric_token_with_http_info(user_id, token_uuid, biometric_token_updater, opts)
|
|
5044
|
+
data
|
|
5045
|
+
end
|
|
5046
|
+
|
|
5047
|
+
# Update biometric token
|
|
5048
|
+
# Updates a biometric token's status.
|
|
5049
|
+
# @param user_id [String] Customer user ID that owns the biometric token.
|
|
5050
|
+
# @param token_uuid [String] Biometric token UUID.
|
|
5051
|
+
# @param biometric_token_updater [BiometricTokenUpdater] Biometric token update payload.
|
|
5052
|
+
# @param [Hash] opts the optional parameters
|
|
5053
|
+
# @return [Array<(UpdatedBiometricTokenResponse, Integer, Hash)>] UpdatedBiometricTokenResponse data, response status code and response headers
|
|
5054
|
+
def update_biometric_token_with_http_info(user_id, token_uuid, biometric_token_updater, opts = {})
|
|
5055
|
+
if @api_client.config.debugging
|
|
5056
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.update_biometric_token ...'
|
|
5057
|
+
end
|
|
5058
|
+
# verify the required parameter 'user_id' is set
|
|
5059
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
5060
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.update_biometric_token"
|
|
5061
|
+
end
|
|
5062
|
+
# verify the required parameter 'token_uuid' is set
|
|
5063
|
+
if @api_client.config.client_side_validation && token_uuid.nil?
|
|
5064
|
+
fail ArgumentError, "Missing the required parameter 'token_uuid' when calling DefaultApi.update_biometric_token"
|
|
5065
|
+
end
|
|
5066
|
+
# verify the required parameter 'biometric_token_updater' is set
|
|
5067
|
+
if @api_client.config.client_side_validation && biometric_token_updater.nil?
|
|
5068
|
+
fail ArgumentError, "Missing the required parameter 'biometric_token_updater' when calling DefaultApi.update_biometric_token"
|
|
5069
|
+
end
|
|
5070
|
+
# resource path
|
|
5071
|
+
local_var_path = '/biometric_tokens/{user_id}/{token_uuid}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'token_uuid' + '}', CGI.escape(token_uuid.to_s))
|
|
5072
|
+
|
|
5073
|
+
# query parameters
|
|
5074
|
+
query_params = opts[:query_params] || {}
|
|
5075
|
+
|
|
5076
|
+
# header parameters
|
|
5077
|
+
header_params = opts[:header_params] || {}
|
|
5078
|
+
# HTTP header 'Accept' (if needed)
|
|
5079
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
5080
|
+
# HTTP header 'Content-Type'
|
|
5081
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
5082
|
+
if !content_type.nil?
|
|
5083
|
+
header_params['Content-Type'] = content_type
|
|
5084
|
+
end
|
|
5085
|
+
|
|
5086
|
+
# form parameters
|
|
5087
|
+
form_params = opts[:form_params] || {}
|
|
5088
|
+
|
|
5089
|
+
# http body (model)
|
|
5090
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(biometric_token_updater)
|
|
5091
|
+
|
|
5092
|
+
# return_type
|
|
5093
|
+
return_type = opts[:debug_return_type] || 'UpdatedBiometricTokenResponse'
|
|
5094
|
+
|
|
5095
|
+
# auth_names
|
|
5096
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
5097
|
+
|
|
5098
|
+
new_options = opts.merge(
|
|
5099
|
+
:operation => :"DefaultApi.update_biometric_token",
|
|
5100
|
+
:header_params => header_params,
|
|
5101
|
+
:query_params => query_params,
|
|
5102
|
+
:form_params => form_params,
|
|
5103
|
+
:body => post_body,
|
|
5104
|
+
:auth_names => auth_names,
|
|
5105
|
+
:return_type => return_type
|
|
5106
|
+
)
|
|
5107
|
+
|
|
5108
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
5109
|
+
if @api_client.config.debugging
|
|
5110
|
+
@api_client.config.logger.debug "API called: DefaultApi#update_biometric_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5111
|
+
end
|
|
5112
|
+
return data, status_code, headers
|
|
5113
|
+
end
|
|
5114
|
+
|
|
5115
|
+
# Update passkey
|
|
5116
|
+
# Updates a passkey's state.
|
|
5117
|
+
# @param username [String] Username that owns the passkey.
|
|
5118
|
+
# @param passkey_id [String] Passkey ID.
|
|
5119
|
+
# @param passkey_updater [PasskeyUpdater] Passkey update payload.
|
|
5120
|
+
# @param [Hash] opts the optional parameters
|
|
5121
|
+
# @return [Passkey]
|
|
5122
|
+
def update_passkey(username, passkey_id, passkey_updater, opts = {})
|
|
5123
|
+
data, _status_code, _headers = update_passkey_with_http_info(username, passkey_id, passkey_updater, opts)
|
|
5124
|
+
data
|
|
5125
|
+
end
|
|
5126
|
+
|
|
5127
|
+
# Update passkey
|
|
5128
|
+
# Updates a passkey's state.
|
|
5129
|
+
# @param username [String] Username that owns the passkey.
|
|
5130
|
+
# @param passkey_id [String] Passkey ID.
|
|
5131
|
+
# @param passkey_updater [PasskeyUpdater] Passkey update payload.
|
|
5132
|
+
# @param [Hash] opts the optional parameters
|
|
5133
|
+
# @return [Array<(Passkey, Integer, Hash)>] Passkey data, response status code and response headers
|
|
5134
|
+
def update_passkey_with_http_info(username, passkey_id, passkey_updater, opts = {})
|
|
5135
|
+
if @api_client.config.debugging
|
|
5136
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.update_passkey ...'
|
|
5137
|
+
end
|
|
5138
|
+
# verify the required parameter 'username' is set
|
|
5139
|
+
if @api_client.config.client_side_validation && username.nil?
|
|
5140
|
+
fail ArgumentError, "Missing the required parameter 'username' when calling DefaultApi.update_passkey"
|
|
5141
|
+
end
|
|
5142
|
+
# verify the required parameter 'passkey_id' is set
|
|
5143
|
+
if @api_client.config.client_side_validation && passkey_id.nil?
|
|
5144
|
+
fail ArgumentError, "Missing the required parameter 'passkey_id' when calling DefaultApi.update_passkey"
|
|
5145
|
+
end
|
|
5146
|
+
# verify the required parameter 'passkey_updater' is set
|
|
5147
|
+
if @api_client.config.client_side_validation && passkey_updater.nil?
|
|
5148
|
+
fail ArgumentError, "Missing the required parameter 'passkey_updater' when calling DefaultApi.update_passkey"
|
|
5149
|
+
end
|
|
5150
|
+
# resource path
|
|
5151
|
+
local_var_path = '/passkeys/{username}/{passkey_id}'.sub('{' + 'username' + '}', CGI.escape(username.to_s)).sub('{' + 'passkey_id' + '}', CGI.escape(passkey_id.to_s))
|
|
5152
|
+
|
|
5153
|
+
# query parameters
|
|
5154
|
+
query_params = opts[:query_params] || {}
|
|
5155
|
+
|
|
5156
|
+
# header parameters
|
|
5157
|
+
header_params = opts[:header_params] || {}
|
|
5158
|
+
# HTTP header 'Accept' (if needed)
|
|
5159
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
5160
|
+
# HTTP header 'Content-Type'
|
|
5161
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
5162
|
+
if !content_type.nil?
|
|
5163
|
+
header_params['Content-Type'] = content_type
|
|
5164
|
+
end
|
|
5165
|
+
|
|
5166
|
+
# form parameters
|
|
5167
|
+
form_params = opts[:form_params] || {}
|
|
5168
|
+
|
|
5169
|
+
# http body (model)
|
|
5170
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(passkey_updater)
|
|
5171
|
+
|
|
5172
|
+
# return_type
|
|
5173
|
+
return_type = opts[:debug_return_type] || 'Passkey'
|
|
5174
|
+
|
|
5175
|
+
# auth_names
|
|
5176
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
5177
|
+
|
|
5178
|
+
new_options = opts.merge(
|
|
5179
|
+
:operation => :"DefaultApi.update_passkey",
|
|
5180
|
+
:header_params => header_params,
|
|
5181
|
+
:query_params => query_params,
|
|
5182
|
+
:form_params => form_params,
|
|
5183
|
+
:body => post_body,
|
|
5184
|
+
:auth_names => auth_names,
|
|
5185
|
+
:return_type => return_type
|
|
5186
|
+
)
|
|
5187
|
+
|
|
5188
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
5189
|
+
if @api_client.config.debugging
|
|
5190
|
+
@api_client.config.logger.debug "API called: DefaultApi#update_passkey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5191
|
+
end
|
|
5192
|
+
return data, status_code, headers
|
|
5193
|
+
end
|
|
5194
|
+
|
|
4174
5195
|
# Set match status (BETA)
|
|
4175
5196
|
# Update the status of the given matches
|
|
4176
5197
|
# @param monitor_id [String]
|
|
@@ -4226,7 +5247,7 @@ module Onfido
|
|
|
4226
5247
|
return_type = opts[:debug_return_type] || 'WatchlistMonitorMatchesList'
|
|
4227
5248
|
|
|
4228
5249
|
# auth_names
|
|
4229
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
5250
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
4230
5251
|
|
|
4231
5252
|
new_options = opts.merge(
|
|
4232
5253
|
:operation => :"DefaultApi.update_watchlist_monitor_match",
|
|
@@ -4300,7 +5321,7 @@ module Onfido
|
|
|
4300
5321
|
return_type = opts[:debug_return_type] || 'Webhook'
|
|
4301
5322
|
|
|
4302
5323
|
# auth_names
|
|
4303
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
5324
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
4304
5325
|
|
|
4305
5326
|
new_options = opts.merge(
|
|
4306
5327
|
:operation => :"DefaultApi.update_webhook",
|
|
@@ -4402,7 +5423,7 @@ module Onfido
|
|
|
4402
5423
|
return_type = opts[:debug_return_type] || 'Document'
|
|
4403
5424
|
|
|
4404
5425
|
# auth_names
|
|
4405
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
5426
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
4406
5427
|
|
|
4407
5428
|
new_options = opts.merge(
|
|
4408
5429
|
:operation => :"DefaultApi.upload_document",
|
|
@@ -4470,7 +5491,7 @@ module Onfido
|
|
|
4470
5491
|
return_type = opts[:debug_return_type] || 'IdPhoto'
|
|
4471
5492
|
|
|
4472
5493
|
# auth_names
|
|
4473
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
5494
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
4474
5495
|
|
|
4475
5496
|
new_options = opts.merge(
|
|
4476
5497
|
:operation => :"DefaultApi.upload_id_photo",
|
|
@@ -4541,7 +5562,7 @@ module Onfido
|
|
|
4541
5562
|
return_type = opts[:debug_return_type] || 'LivePhoto'
|
|
4542
5563
|
|
|
4543
5564
|
# auth_names
|
|
4544
|
-
auth_names = opts[:debug_auth_names] || ['Token']
|
|
5565
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
4545
5566
|
|
|
4546
5567
|
new_options = opts.merge(
|
|
4547
5568
|
:operation => :"DefaultApi.upload_live_photo",
|
|
@@ -4559,5 +5580,81 @@ module Onfido
|
|
|
4559
5580
|
end
|
|
4560
5581
|
return data, status_code, headers
|
|
4561
5582
|
end
|
|
5583
|
+
|
|
5584
|
+
# Upload a signing document
|
|
5585
|
+
# 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.
|
|
5586
|
+
# @param applicant_id [String] The ID of the applicant whose signing document is being uploaded.
|
|
5587
|
+
# @param file [File] The file to be uploaded.
|
|
5588
|
+
# @param [Hash] opts the optional parameters
|
|
5589
|
+
# @return [SigningDocument]
|
|
5590
|
+
def upload_signing_document(applicant_id, file, opts = {})
|
|
5591
|
+
data, _status_code, _headers = upload_signing_document_with_http_info(applicant_id, file, opts)
|
|
5592
|
+
data
|
|
5593
|
+
end
|
|
5594
|
+
|
|
5595
|
+
# Upload a signing document
|
|
5596
|
+
# 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.
|
|
5597
|
+
# @param applicant_id [String] The ID of the applicant whose signing document is being uploaded.
|
|
5598
|
+
# @param file [File] The file to be uploaded.
|
|
5599
|
+
# @param [Hash] opts the optional parameters
|
|
5600
|
+
# @return [Array<(SigningDocument, Integer, Hash)>] SigningDocument data, response status code and response headers
|
|
5601
|
+
def upload_signing_document_with_http_info(applicant_id, file, opts = {})
|
|
5602
|
+
if @api_client.config.debugging
|
|
5603
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.upload_signing_document ...'
|
|
5604
|
+
end
|
|
5605
|
+
# verify the required parameter 'applicant_id' is set
|
|
5606
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
|
5607
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.upload_signing_document"
|
|
5608
|
+
end
|
|
5609
|
+
# verify the required parameter 'file' is set
|
|
5610
|
+
if @api_client.config.client_side_validation && file.nil?
|
|
5611
|
+
fail ArgumentError, "Missing the required parameter 'file' when calling DefaultApi.upload_signing_document"
|
|
5612
|
+
end
|
|
5613
|
+
# resource path
|
|
5614
|
+
local_var_path = '/signing_documents'
|
|
5615
|
+
|
|
5616
|
+
# query parameters
|
|
5617
|
+
query_params = opts[:query_params] || {}
|
|
5618
|
+
|
|
5619
|
+
# header parameters
|
|
5620
|
+
header_params = opts[:header_params] || {}
|
|
5621
|
+
# HTTP header 'Accept' (if needed)
|
|
5622
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
5623
|
+
# HTTP header 'Content-Type'
|
|
5624
|
+
content_type = @api_client.select_header_content_type(['multipart/form-data'])
|
|
5625
|
+
if !content_type.nil?
|
|
5626
|
+
header_params['Content-Type'] = content_type
|
|
5627
|
+
end
|
|
5628
|
+
|
|
5629
|
+
# form parameters
|
|
5630
|
+
form_params = opts[:form_params] || {}
|
|
5631
|
+
form_params['applicant_id'] = applicant_id
|
|
5632
|
+
form_params['file'] = file
|
|
5633
|
+
|
|
5634
|
+
# http body (model)
|
|
5635
|
+
post_body = opts[:debug_body]
|
|
5636
|
+
|
|
5637
|
+
# return_type
|
|
5638
|
+
return_type = opts[:debug_return_type] || 'SigningDocument'
|
|
5639
|
+
|
|
5640
|
+
# auth_names
|
|
5641
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
|
|
5642
|
+
|
|
5643
|
+
new_options = opts.merge(
|
|
5644
|
+
:operation => :"DefaultApi.upload_signing_document",
|
|
5645
|
+
:header_params => header_params,
|
|
5646
|
+
:query_params => query_params,
|
|
5647
|
+
:form_params => form_params,
|
|
5648
|
+
:body => post_body,
|
|
5649
|
+
:auth_names => auth_names,
|
|
5650
|
+
:return_type => return_type
|
|
5651
|
+
)
|
|
5652
|
+
|
|
5653
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
5654
|
+
if @api_client.config.debugging
|
|
5655
|
+
@api_client.config.logger.debug "API called: DefaultApi#upload_signing_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5656
|
+
end
|
|
5657
|
+
return data, status_code, headers
|
|
5658
|
+
end
|
|
4562
5659
|
end
|
|
4563
5660
|
end
|