onfido 2.9.0 → 3.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +11 -4
- data/Gemfile +5 -4
- data/LICENSE +5 -7
- data/README.md +69 -51
- data/Rakefile +10 -0
- data/lib/onfido/api/default_api.rb +4233 -0
- data/lib/onfido/api_client.rb +431 -0
- data/lib/onfido/api_error.rb +58 -0
- data/lib/onfido/configuration.rb +420 -0
- data/lib/onfido/models/address.rb +422 -0
- data/lib/onfido/models/address_builder.rb +422 -0
- data/lib/onfido/models/address_shared.rb +415 -0
- data/lib/onfido/models/addresses_list.rb +216 -0
- data/lib/onfido/models/applicant.rb +390 -0
- data/lib/onfido/models/applicant_builder.rb +358 -0
- data/lib/onfido/models/applicant_create.rb +281 -0
- data/lib/onfido/models/applicant_request.rb +232 -0
- data/lib/onfido/models/applicant_response.rb +341 -0
- data/lib/onfido/models/applicant_shared.rb +246 -0
- data/lib/onfido/models/applicant_update.rb +267 -0
- data/lib/onfido/models/applicant_updater.rb +344 -0
- data/lib/onfido/models/applicants_list.rb +223 -0
- data/lib/onfido/models/check.rb +419 -0
- data/lib/onfido/models/check_builder.rb +360 -0
- data/lib/onfido/models/check_request.rb +301 -0
- data/lib/onfido/models/check_response.rb +350 -0
- data/lib/onfido/models/check_shared.rb +266 -0
- data/lib/onfido/models/checks_list.rb +223 -0
- data/lib/onfido/models/complete_task_builder.rb +221 -0
- data/lib/onfido/models/complete_task_data_builder.rb +106 -0
- data/lib/onfido/models/consent_item.rb +272 -0
- data/lib/onfido/models/consents_builder.rb +205 -0
- data/lib/onfido/models/country_codes.rb +289 -0
- data/lib/onfido/models/device_intelligence_breakdown.rb +223 -0
- data/lib/onfido/models/device_intelligence_breakdown_breakdown.rb +214 -0
- data/lib/onfido/models/device_intelligence_breakdown_breakdown_device.rb +215 -0
- data/lib/onfido/models/device_intelligence_breakdown_breakdown_device_breakdown.rb +232 -0
- data/lib/onfido/models/device_intelligence_breakdown_properties.rb +232 -0
- data/lib/onfido/models/device_intelligence_breakdown_properties_device.rb +468 -0
- data/lib/onfido/models/device_intelligence_breakdown_properties_geolocation.rb +257 -0
- data/lib/onfido/models/device_intelligence_breakdown_properties_ip.rb +245 -0
- data/lib/onfido/models/device_intelligence_report.rb +345 -0
- data/lib/onfido/models/document.rb +376 -0
- data/lib/onfido/models/document_breakdown.rb +286 -0
- data/lib/onfido/models/document_breakdown_age_validation.rb +224 -0
- data/lib/onfido/models/document_breakdown_age_validation_breakdown.rb +214 -0
- data/lib/onfido/models/document_breakdown_compromised_document.rb +224 -0
- data/lib/onfido/models/document_breakdown_compromised_document_breakdown.rb +223 -0
- data/lib/onfido/models/document_breakdown_data_comparison.rb +224 -0
- data/lib/onfido/models/document_breakdown_data_comparison_breakdown.rb +277 -0
- data/lib/onfido/models/document_breakdown_data_comparison_breakdown_issuing_country.rb +223 -0
- data/lib/onfido/models/document_breakdown_data_consistency.rb +224 -0
- data/lib/onfido/models/document_breakdown_data_consistency_breakdown.rb +295 -0
- data/lib/onfido/models/document_breakdown_data_validation.rb +224 -0
- data/lib/onfido/models/document_breakdown_data_validation_breakdown.rb +268 -0
- data/lib/onfido/models/document_breakdown_data_validation_breakdown_document_expiration.rb +224 -0
- data/lib/onfido/models/document_breakdown_data_validation_breakdown_expiry_date.rb +224 -0
- data/lib/onfido/models/document_breakdown_image_integrity.rb +224 -0
- data/lib/onfido/models/document_breakdown_image_integrity_breakdown.rb +241 -0
- data/lib/onfido/models/document_breakdown_image_integrity_breakdown_colour_picture.rb +224 -0
- data/lib/onfido/models/document_breakdown_image_integrity_breakdown_conclusive_document_quality.rb +224 -0
- data/lib/onfido/models/document_breakdown_image_integrity_breakdown_image_quality.rb +224 -0
- data/lib/onfido/models/document_breakdown_image_integrity_breakdown_supported_document.rb +224 -0
- data/lib/onfido/models/document_breakdown_issuing_authority.rb +224 -0
- data/lib/onfido/models/document_breakdown_issuing_authority_breakdown.rb +223 -0
- data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_active_authentication.rb +224 -0
- data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_passive_authentication.rb +224 -0
- data/lib/onfido/models/document_breakdown_police_record.rb +215 -0
- data/lib/onfido/models/document_breakdown_visual_authenticity.rb +224 -0
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown.rb +277 -0
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_digital_tampering.rb +224 -0
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_face_detection.rb +224 -0
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_fonts.rb +224 -0
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_original_document_present.rb +224 -0
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_other.rb +224 -0
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_picture_face_integrity.rb +224 -0
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_security_features.rb +224 -0
- data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_template.rb +224 -0
- data/lib/onfido/models/document_cdq_reasons.rb +285 -0
- data/lib/onfido/models/document_iq_reasons.rb +305 -0
- data/lib/onfido/models/document_odp_reasons.rb +245 -0
- data/lib/onfido/models/document_properties.rb +663 -0
- data/lib/onfido/models/document_properties_address_lines.rb +259 -0
- data/lib/onfido/models/document_properties_barcode_inner.rb +367 -0
- data/lib/onfido/models/document_properties_document_classification.rb +232 -0
- data/lib/onfido/models/document_properties_document_numbers_inner.rb +223 -0
- data/lib/onfido/models/document_properties_driving_licence_information.rb +241 -0
- data/lib/onfido/models/document_properties_extracted_data.rb +394 -0
- data/lib/onfido/models/document_properties_nfc.rb +322 -0
- data/lib/onfido/models/document_report.rb +354 -0
- data/lib/onfido/models/document_response.rb +272 -0
- data/lib/onfido/models/document_shared.rb +301 -0
- data/lib/onfido/models/document_types.rb +64 -0
- data/lib/onfido/models/document_video_report.rb +354 -0
- data/lib/onfido/models/document_video_with_address_information_report.rb +354 -0
- data/lib/onfido/models/document_with_address_information_report.rb +354 -0
- data/lib/onfido/models/document_with_driver_verification_report.rb +354 -0
- data/lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb +731 -0
- data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle.rb +236 -0
- data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner.rb +245 -0
- data/lib/onfido/models/document_with_driving_licence_information_report.rb +354 -0
- data/lib/onfido/models/documents_list.rb +223 -0
- data/lib/onfido/models/error.rb +214 -0
- data/lib/onfido/models/error1.rb +224 -0
- data/lib/onfido/models/error_properties.rb +234 -0
- data/lib/onfido/models/error_properties1.rb +223 -0
- data/lib/onfido/models/extract_request.rb +222 -0
- data/lib/onfido/models/extraction.rb +233 -0
- data/lib/onfido/models/extraction_document_classification.rb +289 -0
- data/lib/onfido/models/extraction_extracted_data.rb +530 -0
- data/lib/onfido/models/facial_similarity_motion_breakdown.rb +232 -0
- data/lib/onfido/models/facial_similarity_motion_breakdown_face_comparison.rb +224 -0
- data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity.rb +224 -0
- data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown.rb +223 -0
- data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_face_detected.rb +224 -0
- data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_source_integrity.rb +224 -0
- data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity.rb +224 -0
- data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown.rb +223 -0
- data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +224 -0
- data/lib/onfido/models/facial_similarity_motion_properties.rb +215 -0
- data/lib/onfido/models/facial_similarity_motion_report.rb +354 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown.rb +232 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison.rb +224 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown.rb +214 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match.rb +224 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match_properties.rb +225 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity.rb +224 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown.rb +223 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_face_detected.rb +224 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_source_integrity.rb +224 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity.rb +224 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown.rb +214 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +224 -0
- data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection_properties.rb +215 -0
- data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown.rb +232 -0
- data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity.rb +224 -0
- data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown.rb +223 -0
- data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity.rb +224 -0
- data/lib/onfido/models/facial_similarity_photo_fully_auto_properties.rb +215 -0
- data/lib/onfido/models/facial_similarity_photo_fully_auto_report.rb +354 -0
- data/lib/onfido/models/facial_similarity_photo_properties.rb +215 -0
- data/lib/onfido/models/facial_similarity_photo_report.rb +354 -0
- data/lib/onfido/models/facial_similarity_video_breakdown.rb +232 -0
- data/lib/onfido/models/facial_similarity_video_breakdown_face_comparison.rb +224 -0
- data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity.rb +224 -0
- data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown.rb +223 -0
- data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected.rb +224 -0
- data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity.rb +224 -0
- data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity.rb +224 -0
- data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown.rb +223 -0
- data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected.rb +224 -0
- data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +224 -0
- data/lib/onfido/models/facial_similarity_video_properties.rb +215 -0
- data/lib/onfido/models/facial_similarity_video_report.rb +354 -0
- data/lib/onfido/models/id_number.rb +269 -0
- data/lib/onfido/models/id_photo.rb +289 -0
- data/lib/onfido/models/id_photo_response.rb +282 -0
- data/lib/onfido/models/id_photos_list.rb +223 -0
- data/lib/onfido/models/identity_enhanced_breakdown.rb +241 -0
- data/lib/onfido/models/identity_enhanced_breakdown_address.rb +224 -0
- data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown.rb +232 -0
- data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies.rb +224 -0
- data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies_properties.rb +214 -0
- data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_telephone_database.rb +224 -0
- data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_voting_register.rb +224 -0
- data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth.rb +224 -0
- data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown.rb +223 -0
- data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies.rb +224 -0
- data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_voting_register.rb +224 -0
- data/lib/onfido/models/identity_enhanced_breakdown_mortality.rb +215 -0
- data/lib/onfido/models/identity_enhanced_breakdown_sources.rb +224 -0
- data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown.rb +214 -0
- data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources.rb +224 -0
- data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources_properties.rb +214 -0
- data/lib/onfido/models/identity_enhanced_properties.rb +227 -0
- data/lib/onfido/models/identity_enhanced_properties_matched_addresses_inner.rb +227 -0
- data/lib/onfido/models/identity_enhanced_report.rb +354 -0
- data/lib/onfido/models/india_pan_report.rb +354 -0
- data/lib/onfido/models/india_pan_report_all_of_breakdown.rb +214 -0
- data/lib/onfido/models/india_pan_report_all_of_breakdown_device.rb +214 -0
- data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown.rb +223 -0
- data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown_pan_valid.rb +214 -0
- data/lib/onfido/models/india_pan_report_all_of_properties.rb +214 -0
- data/lib/onfido/models/india_pan_report_all_of_properties_device.rb +225 -0
- data/lib/onfido/models/known_faces_breakdown.rb +223 -0
- data/lib/onfido/models/known_faces_breakdown_image_integrity.rb +215 -0
- data/lib/onfido/models/known_faces_breakdown_previously_seen_faces.rb +215 -0
- data/lib/onfido/models/known_faces_properties.rb +217 -0
- data/lib/onfido/models/known_faces_properties_matches_inner.rb +255 -0
- data/lib/onfido/models/known_faces_report.rb +354 -0
- data/lib/onfido/models/live_photo.rb +289 -0
- data/lib/onfido/models/live_photo_response.rb +282 -0
- data/lib/onfido/models/live_photos_list.rb +223 -0
- data/lib/onfido/models/live_video.rb +287 -0
- data/lib/onfido/models/live_videos_list.rb +223 -0
- data/lib/onfido/models/location.rb +254 -0
- data/lib/onfido/models/location_builder.rb +254 -0
- data/lib/onfido/models/location_shared.rb +247 -0
- data/lib/onfido/models/motion_capture.rb +275 -0
- data/lib/onfido/models/motion_captures_list.rb +223 -0
- data/lib/onfido/models/photo_auto_reasons.rb +255 -0
- data/lib/onfido/models/photo_reasons.rb +255 -0
- data/lib/onfido/models/proof_of_address_breakdown.rb +232 -0
- data/lib/onfido/models/proof_of_address_breakdown_data_comparison.rb +224 -0
- data/lib/onfido/models/proof_of_address_breakdown_data_comparison_breakdown.rb +232 -0
- data/lib/onfido/models/proof_of_address_breakdown_document_classification.rb +224 -0
- data/lib/onfido/models/proof_of_address_breakdown_document_classification_breakdown.rb +214 -0
- data/lib/onfido/models/proof_of_address_breakdown_image_integrity.rb +224 -0
- data/lib/onfido/models/proof_of_address_breakdown_image_integrity_breakdown.rb +214 -0
- data/lib/onfido/models/proof_of_address_properties.rb +319 -0
- data/lib/onfido/models/proof_of_address_report.rb +354 -0
- data/lib/onfido/models/repeat_attempts_list.rb +292 -0
- data/lib/onfido/models/repeat_attempts_list_repeat_attempts_inner.rb +333 -0
- data/lib/onfido/models/report.rb +93 -0
- data/lib/onfido/models/report_document.rb +222 -0
- data/lib/onfido/models/report_name.rb +60 -0
- data/lib/onfido/models/report_result.rb +42 -0
- data/lib/onfido/models/report_shared.rb +329 -0
- data/lib/onfido/models/report_status.rb +44 -0
- data/lib/onfido/models/report_sub_result.rb +43 -0
- data/lib/onfido/models/reports_list.rb +223 -0
- data/lib/onfido/models/results_feedback.rb +279 -0
- data/lib/onfido/models/sdk_token.rb +229 -0
- data/lib/onfido/models/sdk_token_builder.rb +259 -0
- data/lib/onfido/models/sdk_token_request.rb +252 -0
- data/lib/onfido/models/sdk_token_response.rb +222 -0
- data/lib/onfido/models/task.rb +329 -0
- data/lib/onfido/models/task_item.rb +287 -0
- data/lib/onfido/models/timeline_file_reference.rb +239 -0
- data/lib/onfido/models/us_driving_licence_breakdown.rb +232 -0
- data/lib/onfido/models/us_driving_licence_breakdown_address.rb +224 -0
- data/lib/onfido/models/us_driving_licence_breakdown_address_breakdown.rb +259 -0
- data/lib/onfido/models/us_driving_licence_breakdown_document.rb +224 -0
- data/lib/onfido/models/us_driving_licence_breakdown_document_breakdown.rb +241 -0
- data/lib/onfido/models/us_driving_licence_breakdown_personal.rb +224 -0
- data/lib/onfido/models/us_driving_licence_breakdown_personal_breakdown.rb +322 -0
- data/lib/onfido/models/us_driving_licence_builder.rb +505 -0
- data/lib/onfido/models/us_driving_licence_report.rb +354 -0
- data/lib/onfido/models/us_driving_licence_shared.rb +499 -0
- data/lib/onfido/models/video_reasons.rb +245 -0
- data/lib/onfido/models/watchlist_aml_breakdown.rb +241 -0
- data/lib/onfido/models/watchlist_aml_breakdown_adverse_media.rb +215 -0
- data/lib/onfido/models/watchlist_aml_breakdown_legal_and_regulatory_warnings.rb +215 -0
- data/lib/onfido/models/watchlist_aml_breakdown_politically_exposed_person.rb +215 -0
- data/lib/onfido/models/watchlist_aml_breakdown_sanction.rb +215 -0
- data/lib/onfido/models/watchlist_aml_properties.rb +217 -0
- data/lib/onfido/models/watchlist_aml_report.rb +354 -0
- data/lib/onfido/models/watchlist_enhanced_breakdown.rb +241 -0
- data/lib/onfido/models/watchlist_enhanced_properties.rb +217 -0
- data/lib/onfido/models/watchlist_enhanced_report.rb +354 -0
- data/lib/onfido/models/watchlist_monitor.rb +342 -0
- data/lib/onfido/models/watchlist_monitor_builder.rb +292 -0
- data/lib/onfido/models/watchlist_monitor_match.rb +225 -0
- data/lib/onfido/models/watchlist_monitor_matches_list.rb +223 -0
- data/lib/onfido/models/watchlist_monitor_matches_updater.rb +227 -0
- data/lib/onfido/models/watchlist_monitor_response.rb +254 -0
- data/lib/onfido/models/watchlist_monitor_shared.rb +285 -0
- data/lib/onfido/models/watchlist_monitors_list.rb +223 -0
- data/lib/onfido/models/watchlist_peps_only_report.rb +354 -0
- data/lib/onfido/models/watchlist_sanctions_only_report.rb +354 -0
- data/lib/onfido/models/watchlist_standard_breakdown.rb +232 -0
- data/lib/onfido/models/watchlist_standard_properties.rb +217 -0
- data/lib/onfido/models/watchlist_standard_report.rb +354 -0
- data/lib/onfido/models/webhook.rb +304 -0
- data/lib/onfido/models/webhook_builder.rb +274 -0
- data/lib/onfido/models/webhook_create.rb +222 -0
- data/lib/onfido/models/webhook_event.rb +214 -0
- data/lib/onfido/models/webhook_event_payload.rb +273 -0
- data/lib/onfido/models/webhook_event_payload_object.rb +260 -0
- data/lib/onfido/models/webhook_event_type.rb +56 -0
- data/lib/onfido/models/webhook_resend.rb +216 -0
- data/lib/onfido/models/webhook_response.rb +252 -0
- data/lib/onfido/models/webhook_shared.rb +249 -0
- data/lib/onfido/models/webhook_update.rb +215 -0
- data/lib/onfido/models/webhook_updater.rb +267 -0
- data/lib/onfido/models/webhooks_list.rb +223 -0
- data/lib/onfido/models/webhooks_resend_item.rb +261 -0
- data/lib/onfido/models/workflow_run.rb +416 -0
- data/lib/onfido/models/workflow_run_builder.rb +316 -0
- data/lib/onfido/models/workflow_run_request.rb +217 -0
- data/lib/onfido/models/workflow_run_response.rb +317 -0
- data/lib/onfido/models/workflow_run_response_error.rb +226 -0
- data/lib/onfido/models/workflow_run_shared.rb +296 -0
- data/lib/onfido/models/workflow_run_shared_link.rb +290 -0
- data/lib/onfido/version.rb +12 -2
- data/lib/onfido/webhook_event_verifier.rb +20 -0
- data/lib/onfido.rb +309 -25
- data/onfido.gemspec +42 -33
- data/spec/integrations/address_picker_spec.rb +16 -0
- data/spec/integrations/applicant_spec.rb +73 -95
- data/spec/integrations/check_spec.rb +60 -41
- data/spec/integrations/document_spec.rb +28 -57
- data/spec/integrations/extraction_spec.rb +27 -12
- data/spec/integrations/id_photo_spec.rb +55 -0
- data/spec/integrations/live_photo_spec.rb +28 -45
- data/spec/integrations/live_video_spec.rb +33 -19
- data/spec/integrations/media/sample_driving_licence.png +0 -0
- data/spec/integrations/media/sample_photo.png +0 -0
- data/spec/integrations/motion_capture_spec.rb +30 -24
- data/spec/integrations/report_schema_spec.rb +45 -0
- data/spec/integrations/report_spec.rb +34 -25
- data/spec/integrations/sdk_token_spec.rb +12 -10
- data/spec/integrations/tasks_spec.rb +45 -0
- data/spec/integrations/watchlist_monitor_spec.rb +73 -0
- data/spec/integrations/webhook_spec.rb +40 -88
- data/spec/integrations/workflow_run_output_spec.rb +117 -0
- data/spec/integrations/workflow_run_spec.rb +64 -34
- data/spec/shared_contexts/with_applicant.rb +24 -0
- data/spec/shared_contexts/with_check.rb +18 -0
- data/spec/shared_contexts/with_document.rb +13 -0
- data/spec/shared_contexts/with_live_photo.rb +18 -0
- data/spec/shared_contexts/with_onfido.rb +14 -0
- data/spec/shared_contexts/with_workflow_run.rb +19 -0
- data/spec/spec_helper.rb +73 -11
- data/spec/webhook_event_verifier_spec.rb +29 -0
- metadata +367 -157
- data/.github/workflows/gem-push.yml +0 -31
- data/.github/workflows/ruby.yml +0 -25
- data/.gitignore +0 -19
- data/.rspec +0 -2
- data/.rubocop.yml +0 -13
- data/lib/onfido/api.rb +0 -65
- data/lib/onfido/errors/connection_error.rb +0 -6
- data/lib/onfido/errors/onfido_error.rb +0 -30
- data/lib/onfido/errors/request_error.rb +0 -6
- data/lib/onfido/errors/server_error.rb +0 -6
- data/lib/onfido/options.rb +0 -38
- data/lib/onfido/resource.rb +0 -153
- data/lib/onfido/resources/address.rb +0 -9
- data/lib/onfido/resources/applicant.rb +0 -29
- data/lib/onfido/resources/check.rb +0 -28
- data/lib/onfido/resources/document.rb +0 -28
- data/lib/onfido/resources/extraction.rb +0 -11
- data/lib/onfido/resources/live_photo.rb +0 -27
- data/lib/onfido/resources/live_video.rb +0 -17
- data/lib/onfido/resources/monitor.rb +0 -32
- data/lib/onfido/resources/motion_capture.rb +0 -21
- data/lib/onfido/resources/report.rb +0 -21
- data/lib/onfido/resources/sdk_token.rb +0 -10
- data/lib/onfido/resources/webhook.rb +0 -40
- data/lib/onfido/resources/workflow_run.rb +0 -21
- data/spec/integrations/address_spec.rb +0 -13
- data/spec/integrations/monitor_spec.rb +0 -100
- data/spec/integrations/resource_spec.rb +0 -106
- data/spec/onfido/api_spec.rb +0 -22
- data/spec/onfido/connection_error_spec.rb +0 -20
- data/spec/onfido/options_spec.rb +0 -39
- data/spec/onfido/request_error_spec.rb +0 -36
- data/spec/support/fake_onfido_api.rb +0 -295
- data/spec/support/fixtures/4xx_response.json +0 -14
- data/spec/support/fixtures/addresses.json +0 -24
- data/spec/support/fixtures/applicant.json +0 -28
- data/spec/support/fixtures/applicants.json +0 -12
- data/spec/support/fixtures/check.json +0 -12
- data/spec/support/fixtures/checks.json +0 -16
- data/spec/support/fixtures/document.json +0 -10
- data/spec/support/fixtures/documents.json +0 -23
- data/spec/support/fixtures/extraction.json +0 -23
- data/spec/support/fixtures/live_photo.json +0 -9
- data/spec/support/fixtures/live_photos.json +0 -22
- data/spec/support/fixtures/live_video.json +0 -23
- data/spec/support/fixtures/live_videos.json +0 -27
- data/spec/support/fixtures/monitor.json +0 -8
- data/spec/support/fixtures/monitor_matches.json +0 -12
- data/spec/support/fixtures/monitors.json +0 -12
- data/spec/support/fixtures/motion_capture.json +0 -9
- data/spec/support/fixtures/motion_captures.json +0 -13
- data/spec/support/fixtures/not_scheduled_for_deletion_error.json +0 -7
- data/spec/support/fixtures/report.json +0 -10
- data/spec/support/fixtures/reports.json +0 -24
- data/spec/support/fixtures/sdk_token.json +0 -3
- data/spec/support/fixtures/signed_workflow_run.pdf +0 -0
- data/spec/support/fixtures/unexpected_error_format.json +0 -3
- data/spec/support/fixtures/webhook.json +0 -14
- data/spec/support/fixtures/webhooks.json +0 -31
- data/spec/support/fixtures/workflow_run.json +0 -20
- data/spec/support/fixtures/workflow_runs.json +0 -42
@@ -0,0 +1,4233 @@
|
|
1
|
+
=begin
|
2
|
+
#Onfido API v3.6
|
3
|
+
|
4
|
+
#The Onfido API (v3.6)
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v3.6
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.6.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module Onfido
|
16
|
+
class DefaultApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Cancel report
|
23
|
+
# Cancels single paused reports.
|
24
|
+
# @param report_id [String]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [nil]
|
27
|
+
def cancel_report(report_id, opts = {})
|
28
|
+
cancel_report_with_http_info(report_id, opts)
|
29
|
+
nil
|
30
|
+
end
|
31
|
+
|
32
|
+
# Cancel report
|
33
|
+
# Cancels single paused reports.
|
34
|
+
# @param report_id [String]
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
37
|
+
def cancel_report_with_http_info(report_id, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.cancel_report ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'report_id' is set
|
42
|
+
if @api_client.config.client_side_validation && report_id.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'report_id' when calling DefaultApi.cancel_report"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/reports/{report_id}/cancel'.sub('{' + 'report_id' + '}', CGI.escape(report_id.to_s))
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
+
|
56
|
+
# form parameters
|
57
|
+
form_params = opts[:form_params] || {}
|
58
|
+
|
59
|
+
# http body (model)
|
60
|
+
post_body = opts[:debug_body]
|
61
|
+
|
62
|
+
# return_type
|
63
|
+
return_type = opts[:debug_return_type]
|
64
|
+
|
65
|
+
# auth_names
|
66
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
67
|
+
|
68
|
+
new_options = opts.merge(
|
69
|
+
:operation => :"DefaultApi.cancel_report",
|
70
|
+
:header_params => header_params,
|
71
|
+
:query_params => query_params,
|
72
|
+
:form_params => form_params,
|
73
|
+
:body => post_body,
|
74
|
+
:auth_names => auth_names,
|
75
|
+
:return_type => return_type
|
76
|
+
)
|
77
|
+
|
78
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
79
|
+
if @api_client.config.debugging
|
80
|
+
@api_client.config.logger.debug "API called: DefaultApi#cancel_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
81
|
+
end
|
82
|
+
return data, status_code, headers
|
83
|
+
end
|
84
|
+
|
85
|
+
# Complete Task
|
86
|
+
# Completes a Send / Receive Data Task.
|
87
|
+
# @param workflow_run_id [String] The unique identifier of the Workflow Run to which the Task belongs.
|
88
|
+
# @param task_id [String] The identifier of the Task you want to complete.
|
89
|
+
# @param complete_task_builder [CompleteTaskBuilder]
|
90
|
+
# @param [Hash] opts the optional parameters
|
91
|
+
# @return [nil]
|
92
|
+
def complete_task(workflow_run_id, task_id, complete_task_builder, opts = {})
|
93
|
+
complete_task_with_http_info(workflow_run_id, task_id, complete_task_builder, opts)
|
94
|
+
nil
|
95
|
+
end
|
96
|
+
|
97
|
+
# Complete Task
|
98
|
+
# Completes a Send / Receive Data Task.
|
99
|
+
# @param workflow_run_id [String] The unique identifier of the Workflow Run to which the Task belongs.
|
100
|
+
# @param task_id [String] The identifier of the Task you want to complete.
|
101
|
+
# @param complete_task_builder [CompleteTaskBuilder]
|
102
|
+
# @param [Hash] opts the optional parameters
|
103
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
104
|
+
def complete_task_with_http_info(workflow_run_id, task_id, complete_task_builder, opts = {})
|
105
|
+
if @api_client.config.debugging
|
106
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.complete_task ...'
|
107
|
+
end
|
108
|
+
# verify the required parameter 'workflow_run_id' is set
|
109
|
+
if @api_client.config.client_side_validation && workflow_run_id.nil?
|
110
|
+
fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.complete_task"
|
111
|
+
end
|
112
|
+
# verify the required parameter 'task_id' is set
|
113
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
114
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling DefaultApi.complete_task"
|
115
|
+
end
|
116
|
+
# verify the required parameter 'complete_task_builder' is set
|
117
|
+
if @api_client.config.client_side_validation && complete_task_builder.nil?
|
118
|
+
fail ArgumentError, "Missing the required parameter 'complete_task_builder' when calling DefaultApi.complete_task"
|
119
|
+
end
|
120
|
+
# resource path
|
121
|
+
local_var_path = '/workflow_runs/{workflow_run_id}/tasks/{task_id}/complete'.sub('{' + 'workflow_run_id' + '}', CGI.escape(workflow_run_id.to_s)).sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
122
|
+
|
123
|
+
# query parameters
|
124
|
+
query_params = opts[:query_params] || {}
|
125
|
+
|
126
|
+
# header parameters
|
127
|
+
header_params = opts[:header_params] || {}
|
128
|
+
# HTTP header 'Accept' (if needed)
|
129
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
130
|
+
# HTTP header 'Content-Type'
|
131
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
132
|
+
if !content_type.nil?
|
133
|
+
header_params['Content-Type'] = content_type
|
134
|
+
end
|
135
|
+
|
136
|
+
# form parameters
|
137
|
+
form_params = opts[:form_params] || {}
|
138
|
+
|
139
|
+
# http body (model)
|
140
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(complete_task_builder)
|
141
|
+
|
142
|
+
# return_type
|
143
|
+
return_type = opts[:debug_return_type]
|
144
|
+
|
145
|
+
# auth_names
|
146
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
147
|
+
|
148
|
+
new_options = opts.merge(
|
149
|
+
:operation => :"DefaultApi.complete_task",
|
150
|
+
:header_params => header_params,
|
151
|
+
:query_params => query_params,
|
152
|
+
:form_params => form_params,
|
153
|
+
:body => post_body,
|
154
|
+
:auth_names => auth_names,
|
155
|
+
:return_type => return_type
|
156
|
+
)
|
157
|
+
|
158
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
159
|
+
if @api_client.config.debugging
|
160
|
+
@api_client.config.logger.debug "API called: DefaultApi#complete_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
161
|
+
end
|
162
|
+
return data, status_code, headers
|
163
|
+
end
|
164
|
+
|
165
|
+
# Create Applicant
|
166
|
+
# Creates a single applicant. Returns an applicant object.
|
167
|
+
# @param applicant_builder [ApplicantBuilder]
|
168
|
+
# @param [Hash] opts the optional parameters
|
169
|
+
# @return [Applicant]
|
170
|
+
def create_applicant(applicant_builder, opts = {})
|
171
|
+
data, _status_code, _headers = create_applicant_with_http_info(applicant_builder, opts)
|
172
|
+
data
|
173
|
+
end
|
174
|
+
|
175
|
+
# Create Applicant
|
176
|
+
# Creates a single applicant. Returns an applicant object.
|
177
|
+
# @param applicant_builder [ApplicantBuilder]
|
178
|
+
# @param [Hash] opts the optional parameters
|
179
|
+
# @return [Array<(Applicant, Integer, Hash)>] Applicant data, response status code and response headers
|
180
|
+
def create_applicant_with_http_info(applicant_builder, opts = {})
|
181
|
+
if @api_client.config.debugging
|
182
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.create_applicant ...'
|
183
|
+
end
|
184
|
+
# verify the required parameter 'applicant_builder' is set
|
185
|
+
if @api_client.config.client_side_validation && applicant_builder.nil?
|
186
|
+
fail ArgumentError, "Missing the required parameter 'applicant_builder' when calling DefaultApi.create_applicant"
|
187
|
+
end
|
188
|
+
# resource path
|
189
|
+
local_var_path = '/applicants'
|
190
|
+
|
191
|
+
# query parameters
|
192
|
+
query_params = opts[:query_params] || {}
|
193
|
+
|
194
|
+
# header parameters
|
195
|
+
header_params = opts[:header_params] || {}
|
196
|
+
# HTTP header 'Accept' (if needed)
|
197
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
198
|
+
# HTTP header 'Content-Type'
|
199
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
200
|
+
if !content_type.nil?
|
201
|
+
header_params['Content-Type'] = content_type
|
202
|
+
end
|
203
|
+
|
204
|
+
# form parameters
|
205
|
+
form_params = opts[:form_params] || {}
|
206
|
+
|
207
|
+
# http body (model)
|
208
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(applicant_builder)
|
209
|
+
|
210
|
+
# return_type
|
211
|
+
return_type = opts[:debug_return_type] || 'Applicant'
|
212
|
+
|
213
|
+
# auth_names
|
214
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
215
|
+
|
216
|
+
new_options = opts.merge(
|
217
|
+
:operation => :"DefaultApi.create_applicant",
|
218
|
+
:header_params => header_params,
|
219
|
+
:query_params => query_params,
|
220
|
+
:form_params => form_params,
|
221
|
+
:body => post_body,
|
222
|
+
:auth_names => auth_names,
|
223
|
+
:return_type => return_type
|
224
|
+
)
|
225
|
+
|
226
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
227
|
+
if @api_client.config.debugging
|
228
|
+
@api_client.config.logger.debug "API called: DefaultApi#create_applicant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
229
|
+
end
|
230
|
+
return data, status_code, headers
|
231
|
+
end
|
232
|
+
|
233
|
+
# Create a check
|
234
|
+
# Initiates a check for an applicant, which can contain one or more reports. Returns a check object.
|
235
|
+
# @param check_builder [CheckBuilder]
|
236
|
+
# @param [Hash] opts the optional parameters
|
237
|
+
# @return [Check]
|
238
|
+
def create_check(check_builder, opts = {})
|
239
|
+
data, _status_code, _headers = create_check_with_http_info(check_builder, opts)
|
240
|
+
data
|
241
|
+
end
|
242
|
+
|
243
|
+
# Create a check
|
244
|
+
# Initiates a check for an applicant, which can contain one or more reports. Returns a check object.
|
245
|
+
# @param check_builder [CheckBuilder]
|
246
|
+
# @param [Hash] opts the optional parameters
|
247
|
+
# @return [Array<(Check, Integer, Hash)>] Check data, response status code and response headers
|
248
|
+
def create_check_with_http_info(check_builder, opts = {})
|
249
|
+
if @api_client.config.debugging
|
250
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.create_check ...'
|
251
|
+
end
|
252
|
+
# verify the required parameter 'check_builder' is set
|
253
|
+
if @api_client.config.client_side_validation && check_builder.nil?
|
254
|
+
fail ArgumentError, "Missing the required parameter 'check_builder' when calling DefaultApi.create_check"
|
255
|
+
end
|
256
|
+
# resource path
|
257
|
+
local_var_path = '/checks'
|
258
|
+
|
259
|
+
# query parameters
|
260
|
+
query_params = opts[:query_params] || {}
|
261
|
+
|
262
|
+
# header parameters
|
263
|
+
header_params = opts[:header_params] || {}
|
264
|
+
# HTTP header 'Accept' (if needed)
|
265
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
266
|
+
# HTTP header 'Content-Type'
|
267
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
268
|
+
if !content_type.nil?
|
269
|
+
header_params['Content-Type'] = content_type
|
270
|
+
end
|
271
|
+
|
272
|
+
# form parameters
|
273
|
+
form_params = opts[:form_params] || {}
|
274
|
+
|
275
|
+
# http body (model)
|
276
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(check_builder)
|
277
|
+
|
278
|
+
# return_type
|
279
|
+
return_type = opts[:debug_return_type] || 'Check'
|
280
|
+
|
281
|
+
# auth_names
|
282
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
283
|
+
|
284
|
+
new_options = opts.merge(
|
285
|
+
:operation => :"DefaultApi.create_check",
|
286
|
+
:header_params => header_params,
|
287
|
+
:query_params => query_params,
|
288
|
+
:form_params => form_params,
|
289
|
+
:body => post_body,
|
290
|
+
:auth_names => auth_names,
|
291
|
+
:return_type => return_type
|
292
|
+
)
|
293
|
+
|
294
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
295
|
+
if @api_client.config.debugging
|
296
|
+
@api_client.config.logger.debug "API called: DefaultApi#create_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
297
|
+
end
|
298
|
+
return data, status_code, headers
|
299
|
+
end
|
300
|
+
|
301
|
+
# Create Timeline File for Workflow Run
|
302
|
+
# Triggers the generation of the Timeline File for the designated Workflow Run.
|
303
|
+
# @param workflow_run_id [String] The unique identifier of the Workflow Run.
|
304
|
+
# @param [Hash] opts the optional parameters
|
305
|
+
# @return [TimelineFileReference]
|
306
|
+
def create_timeline_file(workflow_run_id, opts = {})
|
307
|
+
data, _status_code, _headers = create_timeline_file_with_http_info(workflow_run_id, opts)
|
308
|
+
data
|
309
|
+
end
|
310
|
+
|
311
|
+
# Create Timeline File for Workflow Run
|
312
|
+
# Triggers the generation of the Timeline File for the designated Workflow Run.
|
313
|
+
# @param workflow_run_id [String] The unique identifier of the Workflow Run.
|
314
|
+
# @param [Hash] opts the optional parameters
|
315
|
+
# @return [Array<(TimelineFileReference, Integer, Hash)>] TimelineFileReference data, response status code and response headers
|
316
|
+
def create_timeline_file_with_http_info(workflow_run_id, opts = {})
|
317
|
+
if @api_client.config.debugging
|
318
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.create_timeline_file ...'
|
319
|
+
end
|
320
|
+
# verify the required parameter 'workflow_run_id' is set
|
321
|
+
if @api_client.config.client_side_validation && workflow_run_id.nil?
|
322
|
+
fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.create_timeline_file"
|
323
|
+
end
|
324
|
+
# resource path
|
325
|
+
local_var_path = '/workflow_runs/{workflow_run_id}/timeline_file'.sub('{' + 'workflow_run_id' + '}', CGI.escape(workflow_run_id.to_s))
|
326
|
+
|
327
|
+
# query parameters
|
328
|
+
query_params = opts[:query_params] || {}
|
329
|
+
|
330
|
+
# header parameters
|
331
|
+
header_params = opts[:header_params] || {}
|
332
|
+
# HTTP header 'Accept' (if needed)
|
333
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
334
|
+
|
335
|
+
# form parameters
|
336
|
+
form_params = opts[:form_params] || {}
|
337
|
+
|
338
|
+
# http body (model)
|
339
|
+
post_body = opts[:debug_body]
|
340
|
+
|
341
|
+
# return_type
|
342
|
+
return_type = opts[:debug_return_type] || 'TimelineFileReference'
|
343
|
+
|
344
|
+
# auth_names
|
345
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
346
|
+
|
347
|
+
new_options = opts.merge(
|
348
|
+
:operation => :"DefaultApi.create_timeline_file",
|
349
|
+
:header_params => header_params,
|
350
|
+
:query_params => query_params,
|
351
|
+
:form_params => form_params,
|
352
|
+
:body => post_body,
|
353
|
+
:auth_names => auth_names,
|
354
|
+
:return_type => return_type
|
355
|
+
)
|
356
|
+
|
357
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
358
|
+
if @api_client.config.debugging
|
359
|
+
@api_client.config.logger.debug "API called: DefaultApi#create_timeline_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
360
|
+
end
|
361
|
+
return data, status_code, headers
|
362
|
+
end
|
363
|
+
|
364
|
+
# Create monitor
|
365
|
+
# Creates a new monitor for the applicant
|
366
|
+
# @param watchlist_monitor_builder [WatchlistMonitorBuilder]
|
367
|
+
# @param [Hash] opts the optional parameters
|
368
|
+
# @return [WatchlistMonitor]
|
369
|
+
def create_watchlist_monitor(watchlist_monitor_builder, opts = {})
|
370
|
+
data, _status_code, _headers = create_watchlist_monitor_with_http_info(watchlist_monitor_builder, opts)
|
371
|
+
data
|
372
|
+
end
|
373
|
+
|
374
|
+
# Create monitor
|
375
|
+
# Creates a new monitor for the applicant
|
376
|
+
# @param watchlist_monitor_builder [WatchlistMonitorBuilder]
|
377
|
+
# @param [Hash] opts the optional parameters
|
378
|
+
# @return [Array<(WatchlistMonitor, Integer, Hash)>] WatchlistMonitor data, response status code and response headers
|
379
|
+
def create_watchlist_monitor_with_http_info(watchlist_monitor_builder, opts = {})
|
380
|
+
if @api_client.config.debugging
|
381
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.create_watchlist_monitor ...'
|
382
|
+
end
|
383
|
+
# verify the required parameter 'watchlist_monitor_builder' is set
|
384
|
+
if @api_client.config.client_side_validation && watchlist_monitor_builder.nil?
|
385
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_monitor_builder' when calling DefaultApi.create_watchlist_monitor"
|
386
|
+
end
|
387
|
+
# resource path
|
388
|
+
local_var_path = '/watchlist_monitors'
|
389
|
+
|
390
|
+
# query parameters
|
391
|
+
query_params = opts[:query_params] || {}
|
392
|
+
|
393
|
+
# header parameters
|
394
|
+
header_params = opts[:header_params] || {}
|
395
|
+
# HTTP header 'Accept' (if needed)
|
396
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
397
|
+
# HTTP header 'Content-Type'
|
398
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
399
|
+
if !content_type.nil?
|
400
|
+
header_params['Content-Type'] = content_type
|
401
|
+
end
|
402
|
+
|
403
|
+
# form parameters
|
404
|
+
form_params = opts[:form_params] || {}
|
405
|
+
|
406
|
+
# http body (model)
|
407
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_monitor_builder)
|
408
|
+
|
409
|
+
# return_type
|
410
|
+
return_type = opts[:debug_return_type] || 'WatchlistMonitor'
|
411
|
+
|
412
|
+
# auth_names
|
413
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
414
|
+
|
415
|
+
new_options = opts.merge(
|
416
|
+
:operation => :"DefaultApi.create_watchlist_monitor",
|
417
|
+
:header_params => header_params,
|
418
|
+
:query_params => query_params,
|
419
|
+
:form_params => form_params,
|
420
|
+
:body => post_body,
|
421
|
+
:auth_names => auth_names,
|
422
|
+
:return_type => return_type
|
423
|
+
)
|
424
|
+
|
425
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
426
|
+
if @api_client.config.debugging
|
427
|
+
@api_client.config.logger.debug "API called: DefaultApi#create_watchlist_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
428
|
+
end
|
429
|
+
return data, status_code, headers
|
430
|
+
end
|
431
|
+
|
432
|
+
# Register webhook
|
433
|
+
# Registers a webhook. Returns a webhook object.
|
434
|
+
# @param webhook_builder [WebhookBuilder]
|
435
|
+
# @param [Hash] opts the optional parameters
|
436
|
+
# @return [Webhook]
|
437
|
+
def create_webhook(webhook_builder, opts = {})
|
438
|
+
data, _status_code, _headers = create_webhook_with_http_info(webhook_builder, opts)
|
439
|
+
data
|
440
|
+
end
|
441
|
+
|
442
|
+
# Register webhook
|
443
|
+
# Registers a webhook. Returns a webhook object.
|
444
|
+
# @param webhook_builder [WebhookBuilder]
|
445
|
+
# @param [Hash] opts the optional parameters
|
446
|
+
# @return [Array<(Webhook, Integer, Hash)>] Webhook data, response status code and response headers
|
447
|
+
def create_webhook_with_http_info(webhook_builder, opts = {})
|
448
|
+
if @api_client.config.debugging
|
449
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.create_webhook ...'
|
450
|
+
end
|
451
|
+
# verify the required parameter 'webhook_builder' is set
|
452
|
+
if @api_client.config.client_side_validation && webhook_builder.nil?
|
453
|
+
fail ArgumentError, "Missing the required parameter 'webhook_builder' when calling DefaultApi.create_webhook"
|
454
|
+
end
|
455
|
+
# resource path
|
456
|
+
local_var_path = '/webhooks'
|
457
|
+
|
458
|
+
# query parameters
|
459
|
+
query_params = opts[:query_params] || {}
|
460
|
+
|
461
|
+
# header parameters
|
462
|
+
header_params = opts[:header_params] || {}
|
463
|
+
# HTTP header 'Accept' (if needed)
|
464
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
465
|
+
# HTTP header 'Content-Type'
|
466
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
467
|
+
if !content_type.nil?
|
468
|
+
header_params['Content-Type'] = content_type
|
469
|
+
end
|
470
|
+
|
471
|
+
# form parameters
|
472
|
+
form_params = opts[:form_params] || {}
|
473
|
+
|
474
|
+
# http body (model)
|
475
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_builder)
|
476
|
+
|
477
|
+
# return_type
|
478
|
+
return_type = opts[:debug_return_type] || 'Webhook'
|
479
|
+
|
480
|
+
# auth_names
|
481
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
482
|
+
|
483
|
+
new_options = opts.merge(
|
484
|
+
:operation => :"DefaultApi.create_webhook",
|
485
|
+
:header_params => header_params,
|
486
|
+
:query_params => query_params,
|
487
|
+
:form_params => form_params,
|
488
|
+
:body => post_body,
|
489
|
+
:auth_names => auth_names,
|
490
|
+
:return_type => return_type
|
491
|
+
)
|
492
|
+
|
493
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
494
|
+
if @api_client.config.debugging
|
495
|
+
@api_client.config.logger.debug "API called: DefaultApi#create_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
496
|
+
end
|
497
|
+
return data, status_code, headers
|
498
|
+
end
|
499
|
+
|
500
|
+
# Create a Workflow Run
|
501
|
+
# Creates and starts a Workflow Run. Returns a Workflow Run object.
|
502
|
+
# @param workflow_run_builder [WorkflowRunBuilder]
|
503
|
+
# @param [Hash] opts the optional parameters
|
504
|
+
# @return [WorkflowRun]
|
505
|
+
def create_workflow_run(workflow_run_builder, opts = {})
|
506
|
+
data, _status_code, _headers = create_workflow_run_with_http_info(workflow_run_builder, opts)
|
507
|
+
data
|
508
|
+
end
|
509
|
+
|
510
|
+
# Create a Workflow Run
|
511
|
+
# Creates and starts a Workflow Run. Returns a Workflow Run object.
|
512
|
+
# @param workflow_run_builder [WorkflowRunBuilder]
|
513
|
+
# @param [Hash] opts the optional parameters
|
514
|
+
# @return [Array<(WorkflowRun, Integer, Hash)>] WorkflowRun data, response status code and response headers
|
515
|
+
def create_workflow_run_with_http_info(workflow_run_builder, opts = {})
|
516
|
+
if @api_client.config.debugging
|
517
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.create_workflow_run ...'
|
518
|
+
end
|
519
|
+
# verify the required parameter 'workflow_run_builder' is set
|
520
|
+
if @api_client.config.client_side_validation && workflow_run_builder.nil?
|
521
|
+
fail ArgumentError, "Missing the required parameter 'workflow_run_builder' when calling DefaultApi.create_workflow_run"
|
522
|
+
end
|
523
|
+
# resource path
|
524
|
+
local_var_path = '/workflow_runs'
|
525
|
+
|
526
|
+
# query parameters
|
527
|
+
query_params = opts[:query_params] || {}
|
528
|
+
|
529
|
+
# header parameters
|
530
|
+
header_params = opts[:header_params] || {}
|
531
|
+
# HTTP header 'Accept' (if needed)
|
532
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
533
|
+
# HTTP header 'Content-Type'
|
534
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
535
|
+
if !content_type.nil?
|
536
|
+
header_params['Content-Type'] = content_type
|
537
|
+
end
|
538
|
+
|
539
|
+
# form parameters
|
540
|
+
form_params = opts[:form_params] || {}
|
541
|
+
|
542
|
+
# http body (model)
|
543
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(workflow_run_builder)
|
544
|
+
|
545
|
+
# return_type
|
546
|
+
return_type = opts[:debug_return_type] || 'WorkflowRun'
|
547
|
+
|
548
|
+
# auth_names
|
549
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
550
|
+
|
551
|
+
new_options = opts.merge(
|
552
|
+
:operation => :"DefaultApi.create_workflow_run",
|
553
|
+
:header_params => header_params,
|
554
|
+
:query_params => query_params,
|
555
|
+
:form_params => form_params,
|
556
|
+
:body => post_body,
|
557
|
+
:auth_names => auth_names,
|
558
|
+
:return_type => return_type
|
559
|
+
)
|
560
|
+
|
561
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
562
|
+
if @api_client.config.debugging
|
563
|
+
@api_client.config.logger.debug "API called: DefaultApi#create_workflow_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
564
|
+
end
|
565
|
+
return data, status_code, headers
|
566
|
+
end
|
567
|
+
|
568
|
+
# Delete Applicant
|
569
|
+
# Deletes a single applicant.
|
570
|
+
# @param applicant_id [String]
|
571
|
+
# @param [Hash] opts the optional parameters
|
572
|
+
# @return [nil]
|
573
|
+
def delete_applicant(applicant_id, opts = {})
|
574
|
+
delete_applicant_with_http_info(applicant_id, opts)
|
575
|
+
nil
|
576
|
+
end
|
577
|
+
|
578
|
+
# Delete Applicant
|
579
|
+
# Deletes a single applicant.
|
580
|
+
# @param applicant_id [String]
|
581
|
+
# @param [Hash] opts the optional parameters
|
582
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
583
|
+
def delete_applicant_with_http_info(applicant_id, opts = {})
|
584
|
+
if @api_client.config.debugging
|
585
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.delete_applicant ...'
|
586
|
+
end
|
587
|
+
# verify the required parameter 'applicant_id' is set
|
588
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
589
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.delete_applicant"
|
590
|
+
end
|
591
|
+
# resource path
|
592
|
+
local_var_path = '/applicants/{applicant_id}'.sub('{' + 'applicant_id' + '}', CGI.escape(applicant_id.to_s))
|
593
|
+
|
594
|
+
# query parameters
|
595
|
+
query_params = opts[:query_params] || {}
|
596
|
+
|
597
|
+
# header parameters
|
598
|
+
header_params = opts[:header_params] || {}
|
599
|
+
# HTTP header 'Accept' (if needed)
|
600
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
601
|
+
|
602
|
+
# form parameters
|
603
|
+
form_params = opts[:form_params] || {}
|
604
|
+
|
605
|
+
# http body (model)
|
606
|
+
post_body = opts[:debug_body]
|
607
|
+
|
608
|
+
# return_type
|
609
|
+
return_type = opts[:debug_return_type]
|
610
|
+
|
611
|
+
# auth_names
|
612
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
613
|
+
|
614
|
+
new_options = opts.merge(
|
615
|
+
:operation => :"DefaultApi.delete_applicant",
|
616
|
+
:header_params => header_params,
|
617
|
+
:query_params => query_params,
|
618
|
+
:form_params => form_params,
|
619
|
+
:body => post_body,
|
620
|
+
:auth_names => auth_names,
|
621
|
+
:return_type => return_type
|
622
|
+
)
|
623
|
+
|
624
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
625
|
+
if @api_client.config.debugging
|
626
|
+
@api_client.config.logger.debug "API called: DefaultApi#delete_applicant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
627
|
+
end
|
628
|
+
return data, status_code, headers
|
629
|
+
end
|
630
|
+
|
631
|
+
# Delete monitor
|
632
|
+
# Deactivates the given monitor
|
633
|
+
# @param monitor_id [String]
|
634
|
+
# @param [Hash] opts the optional parameters
|
635
|
+
# @return [nil]
|
636
|
+
def delete_watchlist_monitor(monitor_id, opts = {})
|
637
|
+
delete_watchlist_monitor_with_http_info(monitor_id, opts)
|
638
|
+
nil
|
639
|
+
end
|
640
|
+
|
641
|
+
# Delete monitor
|
642
|
+
# Deactivates the given monitor
|
643
|
+
# @param monitor_id [String]
|
644
|
+
# @param [Hash] opts the optional parameters
|
645
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
646
|
+
def delete_watchlist_monitor_with_http_info(monitor_id, opts = {})
|
647
|
+
if @api_client.config.debugging
|
648
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.delete_watchlist_monitor ...'
|
649
|
+
end
|
650
|
+
# verify the required parameter 'monitor_id' is set
|
651
|
+
if @api_client.config.client_side_validation && monitor_id.nil?
|
652
|
+
fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DefaultApi.delete_watchlist_monitor"
|
653
|
+
end
|
654
|
+
# resource path
|
655
|
+
local_var_path = '/watchlist_monitors/{monitor_id}'.sub('{' + 'monitor_id' + '}', CGI.escape(monitor_id.to_s))
|
656
|
+
|
657
|
+
# query parameters
|
658
|
+
query_params = opts[:query_params] || {}
|
659
|
+
|
660
|
+
# header parameters
|
661
|
+
header_params = opts[:header_params] || {}
|
662
|
+
# HTTP header 'Accept' (if needed)
|
663
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
664
|
+
|
665
|
+
# form parameters
|
666
|
+
form_params = opts[:form_params] || {}
|
667
|
+
|
668
|
+
# http body (model)
|
669
|
+
post_body = opts[:debug_body]
|
670
|
+
|
671
|
+
# return_type
|
672
|
+
return_type = opts[:debug_return_type]
|
673
|
+
|
674
|
+
# auth_names
|
675
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
676
|
+
|
677
|
+
new_options = opts.merge(
|
678
|
+
:operation => :"DefaultApi.delete_watchlist_monitor",
|
679
|
+
:header_params => header_params,
|
680
|
+
:query_params => query_params,
|
681
|
+
:form_params => form_params,
|
682
|
+
:body => post_body,
|
683
|
+
:auth_names => auth_names,
|
684
|
+
:return_type => return_type
|
685
|
+
)
|
686
|
+
|
687
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
688
|
+
if @api_client.config.debugging
|
689
|
+
@api_client.config.logger.debug "API called: DefaultApi#delete_watchlist_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
690
|
+
end
|
691
|
+
return data, status_code, headers
|
692
|
+
end
|
693
|
+
|
694
|
+
# Delete a webhook
|
695
|
+
# Deletes a webhook.
|
696
|
+
# @param webhook_id [String]
|
697
|
+
# @param [Hash] opts the optional parameters
|
698
|
+
# @return [nil]
|
699
|
+
def delete_webhook(webhook_id, opts = {})
|
700
|
+
delete_webhook_with_http_info(webhook_id, opts)
|
701
|
+
nil
|
702
|
+
end
|
703
|
+
|
704
|
+
# Delete a webhook
|
705
|
+
# Deletes a webhook.
|
706
|
+
# @param webhook_id [String]
|
707
|
+
# @param [Hash] opts the optional parameters
|
708
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
709
|
+
def delete_webhook_with_http_info(webhook_id, opts = {})
|
710
|
+
if @api_client.config.debugging
|
711
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.delete_webhook ...'
|
712
|
+
end
|
713
|
+
# verify the required parameter 'webhook_id' is set
|
714
|
+
if @api_client.config.client_side_validation && webhook_id.nil?
|
715
|
+
fail ArgumentError, "Missing the required parameter 'webhook_id' when calling DefaultApi.delete_webhook"
|
716
|
+
end
|
717
|
+
# resource path
|
718
|
+
local_var_path = '/webhooks/{webhook_id}'.sub('{' + 'webhook_id' + '}', CGI.escape(webhook_id.to_s))
|
719
|
+
|
720
|
+
# query parameters
|
721
|
+
query_params = opts[:query_params] || {}
|
722
|
+
|
723
|
+
# header parameters
|
724
|
+
header_params = opts[:header_params] || {}
|
725
|
+
# HTTP header 'Accept' (if needed)
|
726
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
727
|
+
|
728
|
+
# form parameters
|
729
|
+
form_params = opts[:form_params] || {}
|
730
|
+
|
731
|
+
# http body (model)
|
732
|
+
post_body = opts[:debug_body]
|
733
|
+
|
734
|
+
# return_type
|
735
|
+
return_type = opts[:debug_return_type]
|
736
|
+
|
737
|
+
# auth_names
|
738
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
739
|
+
|
740
|
+
new_options = opts.merge(
|
741
|
+
:operation => :"DefaultApi.delete_webhook",
|
742
|
+
:header_params => header_params,
|
743
|
+
:query_params => query_params,
|
744
|
+
:form_params => form_params,
|
745
|
+
:body => post_body,
|
746
|
+
:auth_names => auth_names,
|
747
|
+
:return_type => return_type
|
748
|
+
)
|
749
|
+
|
750
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
751
|
+
if @api_client.config.debugging
|
752
|
+
@api_client.config.logger.debug "API called: DefaultApi#delete_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
753
|
+
end
|
754
|
+
return data, status_code, headers
|
755
|
+
end
|
756
|
+
|
757
|
+
# Download check
|
758
|
+
# Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
|
759
|
+
# @param check_id [String]
|
760
|
+
# @param [Hash] opts the optional parameters
|
761
|
+
# @return [File]
|
762
|
+
def download_check(check_id, opts = {})
|
763
|
+
data, _status_code, _headers = download_check_with_http_info(check_id, opts)
|
764
|
+
data
|
765
|
+
end
|
766
|
+
|
767
|
+
# Download check
|
768
|
+
# Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
|
769
|
+
# @param check_id [String]
|
770
|
+
# @param [Hash] opts the optional parameters
|
771
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
772
|
+
def download_check_with_http_info(check_id, opts = {})
|
773
|
+
if @api_client.config.debugging
|
774
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.download_check ...'
|
775
|
+
end
|
776
|
+
# verify the required parameter 'check_id' is set
|
777
|
+
if @api_client.config.client_side_validation && check_id.nil?
|
778
|
+
fail ArgumentError, "Missing the required parameter 'check_id' when calling DefaultApi.download_check"
|
779
|
+
end
|
780
|
+
# resource path
|
781
|
+
local_var_path = '/checks/{check_id}/download'.sub('{' + 'check_id' + '}', CGI.escape(check_id.to_s))
|
782
|
+
|
783
|
+
# query parameters
|
784
|
+
query_params = opts[:query_params] || {}
|
785
|
+
|
786
|
+
# header parameters
|
787
|
+
header_params = opts[:header_params] || {}
|
788
|
+
# HTTP header 'Accept' (if needed)
|
789
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
|
790
|
+
|
791
|
+
# form parameters
|
792
|
+
form_params = opts[:form_params] || {}
|
793
|
+
|
794
|
+
# http body (model)
|
795
|
+
post_body = opts[:debug_body]
|
796
|
+
|
797
|
+
# return_type
|
798
|
+
return_type = opts[:debug_return_type] || 'File'
|
799
|
+
|
800
|
+
# auth_names
|
801
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
802
|
+
|
803
|
+
new_options = opts.merge(
|
804
|
+
:operation => :"DefaultApi.download_check",
|
805
|
+
:header_params => header_params,
|
806
|
+
:query_params => query_params,
|
807
|
+
:form_params => form_params,
|
808
|
+
:body => post_body,
|
809
|
+
:auth_names => auth_names,
|
810
|
+
:return_type => return_type
|
811
|
+
)
|
812
|
+
|
813
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
814
|
+
if @api_client.config.debugging
|
815
|
+
@api_client.config.logger.debug "API called: DefaultApi#download_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
816
|
+
end
|
817
|
+
return data, status_code, headers
|
818
|
+
end
|
819
|
+
|
820
|
+
# Download document
|
821
|
+
# Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
822
|
+
# @param document_id [String]
|
823
|
+
# @param [Hash] opts the optional parameters
|
824
|
+
# @return [File]
|
825
|
+
def download_document(document_id, opts = {})
|
826
|
+
data, _status_code, _headers = download_document_with_http_info(document_id, opts)
|
827
|
+
data
|
828
|
+
end
|
829
|
+
|
830
|
+
# Download document
|
831
|
+
# Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
832
|
+
# @param document_id [String]
|
833
|
+
# @param [Hash] opts the optional parameters
|
834
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
835
|
+
def download_document_with_http_info(document_id, opts = {})
|
836
|
+
if @api_client.config.debugging
|
837
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.download_document ...'
|
838
|
+
end
|
839
|
+
# verify the required parameter 'document_id' is set
|
840
|
+
if @api_client.config.client_side_validation && document_id.nil?
|
841
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling DefaultApi.download_document"
|
842
|
+
end
|
843
|
+
# resource path
|
844
|
+
local_var_path = '/documents/{document_id}/download'.sub('{' + 'document_id' + '}', CGI.escape(document_id.to_s))
|
845
|
+
|
846
|
+
# query parameters
|
847
|
+
query_params = opts[:query_params] || {}
|
848
|
+
|
849
|
+
# header parameters
|
850
|
+
header_params = opts[:header_params] || {}
|
851
|
+
# HTTP header 'Accept' (if needed)
|
852
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*', 'application/json'])
|
853
|
+
|
854
|
+
# form parameters
|
855
|
+
form_params = opts[:form_params] || {}
|
856
|
+
|
857
|
+
# http body (model)
|
858
|
+
post_body = opts[:debug_body]
|
859
|
+
|
860
|
+
# return_type
|
861
|
+
return_type = opts[:debug_return_type] || 'File'
|
862
|
+
|
863
|
+
# auth_names
|
864
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
865
|
+
|
866
|
+
new_options = opts.merge(
|
867
|
+
:operation => :"DefaultApi.download_document",
|
868
|
+
:header_params => header_params,
|
869
|
+
:query_params => query_params,
|
870
|
+
:form_params => form_params,
|
871
|
+
:body => post_body,
|
872
|
+
:auth_names => auth_names,
|
873
|
+
:return_type => return_type
|
874
|
+
)
|
875
|
+
|
876
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
877
|
+
if @api_client.config.debugging
|
878
|
+
@api_client.config.logger.debug "API called: DefaultApi#download_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
879
|
+
end
|
880
|
+
return data, status_code, headers
|
881
|
+
end
|
882
|
+
|
883
|
+
# Download document video
|
884
|
+
# Downloads a document video. If successful, the response will be the binary data representing the video.
|
885
|
+
# @param document_id [String]
|
886
|
+
# @param [Hash] opts the optional parameters
|
887
|
+
# @return [File]
|
888
|
+
def download_document_video(document_id, opts = {})
|
889
|
+
data, _status_code, _headers = download_document_video_with_http_info(document_id, opts)
|
890
|
+
data
|
891
|
+
end
|
892
|
+
|
893
|
+
# Download document video
|
894
|
+
# Downloads a document video. If successful, the response will be the binary data representing the video.
|
895
|
+
# @param document_id [String]
|
896
|
+
# @param [Hash] opts the optional parameters
|
897
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
898
|
+
def download_document_video_with_http_info(document_id, opts = {})
|
899
|
+
if @api_client.config.debugging
|
900
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.download_document_video ...'
|
901
|
+
end
|
902
|
+
# verify the required parameter 'document_id' is set
|
903
|
+
if @api_client.config.client_side_validation && document_id.nil?
|
904
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling DefaultApi.download_document_video"
|
905
|
+
end
|
906
|
+
# resource path
|
907
|
+
local_var_path = '/documents/{document_id}/video/download'.sub('{' + 'document_id' + '}', CGI.escape(document_id.to_s))
|
908
|
+
|
909
|
+
# query parameters
|
910
|
+
query_params = opts[:query_params] || {}
|
911
|
+
|
912
|
+
# header parameters
|
913
|
+
header_params = opts[:header_params] || {}
|
914
|
+
# HTTP header 'Accept' (if needed)
|
915
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*', 'application/json'])
|
916
|
+
|
917
|
+
# form parameters
|
918
|
+
form_params = opts[:form_params] || {}
|
919
|
+
|
920
|
+
# http body (model)
|
921
|
+
post_body = opts[:debug_body]
|
922
|
+
|
923
|
+
# return_type
|
924
|
+
return_type = opts[:debug_return_type] || 'File'
|
925
|
+
|
926
|
+
# auth_names
|
927
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
928
|
+
|
929
|
+
new_options = opts.merge(
|
930
|
+
:operation => :"DefaultApi.download_document_video",
|
931
|
+
:header_params => header_params,
|
932
|
+
:query_params => query_params,
|
933
|
+
:form_params => form_params,
|
934
|
+
:body => post_body,
|
935
|
+
:auth_names => auth_names,
|
936
|
+
:return_type => return_type
|
937
|
+
)
|
938
|
+
|
939
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
940
|
+
if @api_client.config.debugging
|
941
|
+
@api_client.config.logger.debug "API called: DefaultApi#download_document_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
942
|
+
end
|
943
|
+
return data, status_code, headers
|
944
|
+
end
|
945
|
+
|
946
|
+
# Download ID photo
|
947
|
+
# ID photos are downloaded using this endpoint.
|
948
|
+
# @param id_photo_id [String] The ID photo's unique identifier.
|
949
|
+
# @param [Hash] opts the optional parameters
|
950
|
+
# @return [File]
|
951
|
+
def download_id_photo(id_photo_id, opts = {})
|
952
|
+
data, _status_code, _headers = download_id_photo_with_http_info(id_photo_id, opts)
|
953
|
+
data
|
954
|
+
end
|
955
|
+
|
956
|
+
# Download ID photo
|
957
|
+
# ID photos are downloaded using this endpoint.
|
958
|
+
# @param id_photo_id [String] The ID photo's unique identifier.
|
959
|
+
# @param [Hash] opts the optional parameters
|
960
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
961
|
+
def download_id_photo_with_http_info(id_photo_id, opts = {})
|
962
|
+
if @api_client.config.debugging
|
963
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.download_id_photo ...'
|
964
|
+
end
|
965
|
+
# verify the required parameter 'id_photo_id' is set
|
966
|
+
if @api_client.config.client_side_validation && id_photo_id.nil?
|
967
|
+
fail ArgumentError, "Missing the required parameter 'id_photo_id' when calling DefaultApi.download_id_photo"
|
968
|
+
end
|
969
|
+
# resource path
|
970
|
+
local_var_path = '/id_photos/{id_photo_id}/download'.sub('{' + 'id_photo_id' + '}', CGI.escape(id_photo_id.to_s))
|
971
|
+
|
972
|
+
# query parameters
|
973
|
+
query_params = opts[:query_params] || {}
|
974
|
+
|
975
|
+
# header parameters
|
976
|
+
header_params = opts[:header_params] || {}
|
977
|
+
# HTTP header 'Accept' (if needed)
|
978
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*', 'application/json'])
|
979
|
+
|
980
|
+
# form parameters
|
981
|
+
form_params = opts[:form_params] || {}
|
982
|
+
|
983
|
+
# http body (model)
|
984
|
+
post_body = opts[:debug_body]
|
985
|
+
|
986
|
+
# return_type
|
987
|
+
return_type = opts[:debug_return_type] || 'File'
|
988
|
+
|
989
|
+
# auth_names
|
990
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
991
|
+
|
992
|
+
new_options = opts.merge(
|
993
|
+
:operation => :"DefaultApi.download_id_photo",
|
994
|
+
:header_params => header_params,
|
995
|
+
:query_params => query_params,
|
996
|
+
:form_params => form_params,
|
997
|
+
:body => post_body,
|
998
|
+
:auth_names => auth_names,
|
999
|
+
:return_type => return_type
|
1000
|
+
)
|
1001
|
+
|
1002
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1003
|
+
if @api_client.config.debugging
|
1004
|
+
@api_client.config.logger.debug "API called: DefaultApi#download_id_photo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1005
|
+
end
|
1006
|
+
return data, status_code, headers
|
1007
|
+
end
|
1008
|
+
|
1009
|
+
# Download live photo
|
1010
|
+
# Live photos are downloaded using this endpoint.
|
1011
|
+
# @param live_photo_id [String] The live photo's unique identifier.
|
1012
|
+
# @param [Hash] opts the optional parameters
|
1013
|
+
# @return [File]
|
1014
|
+
def download_live_photo(live_photo_id, opts = {})
|
1015
|
+
data, _status_code, _headers = download_live_photo_with_http_info(live_photo_id, opts)
|
1016
|
+
data
|
1017
|
+
end
|
1018
|
+
|
1019
|
+
# Download live photo
|
1020
|
+
# Live photos are downloaded using this endpoint.
|
1021
|
+
# @param live_photo_id [String] The live photo's unique identifier.
|
1022
|
+
# @param [Hash] opts the optional parameters
|
1023
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
1024
|
+
def download_live_photo_with_http_info(live_photo_id, opts = {})
|
1025
|
+
if @api_client.config.debugging
|
1026
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.download_live_photo ...'
|
1027
|
+
end
|
1028
|
+
# verify the required parameter 'live_photo_id' is set
|
1029
|
+
if @api_client.config.client_side_validation && live_photo_id.nil?
|
1030
|
+
fail ArgumentError, "Missing the required parameter 'live_photo_id' when calling DefaultApi.download_live_photo"
|
1031
|
+
end
|
1032
|
+
# resource path
|
1033
|
+
local_var_path = '/live_photos/{live_photo_id}/download'.sub('{' + 'live_photo_id' + '}', CGI.escape(live_photo_id.to_s))
|
1034
|
+
|
1035
|
+
# query parameters
|
1036
|
+
query_params = opts[:query_params] || {}
|
1037
|
+
|
1038
|
+
# header parameters
|
1039
|
+
header_params = opts[:header_params] || {}
|
1040
|
+
# HTTP header 'Accept' (if needed)
|
1041
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*', 'application/json'])
|
1042
|
+
|
1043
|
+
# form parameters
|
1044
|
+
form_params = opts[:form_params] || {}
|
1045
|
+
|
1046
|
+
# http body (model)
|
1047
|
+
post_body = opts[:debug_body]
|
1048
|
+
|
1049
|
+
# return_type
|
1050
|
+
return_type = opts[:debug_return_type] || 'File'
|
1051
|
+
|
1052
|
+
# auth_names
|
1053
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1054
|
+
|
1055
|
+
new_options = opts.merge(
|
1056
|
+
:operation => :"DefaultApi.download_live_photo",
|
1057
|
+
:header_params => header_params,
|
1058
|
+
:query_params => query_params,
|
1059
|
+
:form_params => form_params,
|
1060
|
+
:body => post_body,
|
1061
|
+
:auth_names => auth_names,
|
1062
|
+
:return_type => return_type
|
1063
|
+
)
|
1064
|
+
|
1065
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1066
|
+
if @api_client.config.debugging
|
1067
|
+
@api_client.config.logger.debug "API called: DefaultApi#download_live_photo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1068
|
+
end
|
1069
|
+
return data, status_code, headers
|
1070
|
+
end
|
1071
|
+
|
1072
|
+
# Download live video
|
1073
|
+
# Live videos are downloaded using this endpoint.
|
1074
|
+
# @param live_video_id [String] The live video's unique identifier.
|
1075
|
+
# @param [Hash] opts the optional parameters
|
1076
|
+
# @return [File]
|
1077
|
+
def download_live_video(live_video_id, opts = {})
|
1078
|
+
data, _status_code, _headers = download_live_video_with_http_info(live_video_id, opts)
|
1079
|
+
data
|
1080
|
+
end
|
1081
|
+
|
1082
|
+
# Download live video
|
1083
|
+
# Live videos are downloaded using this endpoint.
|
1084
|
+
# @param live_video_id [String] The live video's unique identifier.
|
1085
|
+
# @param [Hash] opts the optional parameters
|
1086
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
1087
|
+
def download_live_video_with_http_info(live_video_id, opts = {})
|
1088
|
+
if @api_client.config.debugging
|
1089
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.download_live_video ...'
|
1090
|
+
end
|
1091
|
+
# verify the required parameter 'live_video_id' is set
|
1092
|
+
if @api_client.config.client_side_validation && live_video_id.nil?
|
1093
|
+
fail ArgumentError, "Missing the required parameter 'live_video_id' when calling DefaultApi.download_live_video"
|
1094
|
+
end
|
1095
|
+
# resource path
|
1096
|
+
local_var_path = '/live_videos/{live_video_id}/download'.sub('{' + 'live_video_id' + '}', CGI.escape(live_video_id.to_s))
|
1097
|
+
|
1098
|
+
# query parameters
|
1099
|
+
query_params = opts[:query_params] || {}
|
1100
|
+
|
1101
|
+
# header parameters
|
1102
|
+
header_params = opts[:header_params] || {}
|
1103
|
+
# HTTP header 'Accept' (if needed)
|
1104
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*', 'application/json'])
|
1105
|
+
|
1106
|
+
# form parameters
|
1107
|
+
form_params = opts[:form_params] || {}
|
1108
|
+
|
1109
|
+
# http body (model)
|
1110
|
+
post_body = opts[:debug_body]
|
1111
|
+
|
1112
|
+
# return_type
|
1113
|
+
return_type = opts[:debug_return_type] || 'File'
|
1114
|
+
|
1115
|
+
# auth_names
|
1116
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1117
|
+
|
1118
|
+
new_options = opts.merge(
|
1119
|
+
:operation => :"DefaultApi.download_live_video",
|
1120
|
+
:header_params => header_params,
|
1121
|
+
:query_params => query_params,
|
1122
|
+
:form_params => form_params,
|
1123
|
+
:body => post_body,
|
1124
|
+
:auth_names => auth_names,
|
1125
|
+
:return_type => return_type
|
1126
|
+
)
|
1127
|
+
|
1128
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1129
|
+
if @api_client.config.debugging
|
1130
|
+
@api_client.config.logger.debug "API called: DefaultApi#download_live_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1131
|
+
end
|
1132
|
+
return data, status_code, headers
|
1133
|
+
end
|
1134
|
+
|
1135
|
+
# Download live video frame
|
1136
|
+
# Returns the binary data representing a single frame from a live video.
|
1137
|
+
# @param live_video_id [String] The live video's unique identifier.
|
1138
|
+
# @param [Hash] opts the optional parameters
|
1139
|
+
# @return [File]
|
1140
|
+
def download_live_video_frame(live_video_id, opts = {})
|
1141
|
+
data, _status_code, _headers = download_live_video_frame_with_http_info(live_video_id, opts)
|
1142
|
+
data
|
1143
|
+
end
|
1144
|
+
|
1145
|
+
# Download live video frame
|
1146
|
+
# Returns the binary data representing a single frame from a live video.
|
1147
|
+
# @param live_video_id [String] The live video's unique identifier.
|
1148
|
+
# @param [Hash] opts the optional parameters
|
1149
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
1150
|
+
def download_live_video_frame_with_http_info(live_video_id, opts = {})
|
1151
|
+
if @api_client.config.debugging
|
1152
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.download_live_video_frame ...'
|
1153
|
+
end
|
1154
|
+
# verify the required parameter 'live_video_id' is set
|
1155
|
+
if @api_client.config.client_side_validation && live_video_id.nil?
|
1156
|
+
fail ArgumentError, "Missing the required parameter 'live_video_id' when calling DefaultApi.download_live_video_frame"
|
1157
|
+
end
|
1158
|
+
# resource path
|
1159
|
+
local_var_path = '/live_videos/{live_video_id}/frame'.sub('{' + 'live_video_id' + '}', CGI.escape(live_video_id.to_s))
|
1160
|
+
|
1161
|
+
# query parameters
|
1162
|
+
query_params = opts[:query_params] || {}
|
1163
|
+
|
1164
|
+
# header parameters
|
1165
|
+
header_params = opts[:header_params] || {}
|
1166
|
+
# HTTP header 'Accept' (if needed)
|
1167
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*', 'application/json'])
|
1168
|
+
|
1169
|
+
# form parameters
|
1170
|
+
form_params = opts[:form_params] || {}
|
1171
|
+
|
1172
|
+
# http body (model)
|
1173
|
+
post_body = opts[:debug_body]
|
1174
|
+
|
1175
|
+
# return_type
|
1176
|
+
return_type = opts[:debug_return_type] || 'File'
|
1177
|
+
|
1178
|
+
# auth_names
|
1179
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1180
|
+
|
1181
|
+
new_options = opts.merge(
|
1182
|
+
:operation => :"DefaultApi.download_live_video_frame",
|
1183
|
+
:header_params => header_params,
|
1184
|
+
:query_params => query_params,
|
1185
|
+
:form_params => form_params,
|
1186
|
+
:body => post_body,
|
1187
|
+
:auth_names => auth_names,
|
1188
|
+
:return_type => return_type
|
1189
|
+
)
|
1190
|
+
|
1191
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1192
|
+
if @api_client.config.debugging
|
1193
|
+
@api_client.config.logger.debug "API called: DefaultApi#download_live_video_frame\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1194
|
+
end
|
1195
|
+
return data, status_code, headers
|
1196
|
+
end
|
1197
|
+
|
1198
|
+
# Download motion capture
|
1199
|
+
# Motion captures are downloaded using this endpoint.
|
1200
|
+
# @param motion_capture_id [String] The motion capture's unique identifier.
|
1201
|
+
# @param [Hash] opts the optional parameters
|
1202
|
+
# @return [File]
|
1203
|
+
def download_motion_capture(motion_capture_id, opts = {})
|
1204
|
+
data, _status_code, _headers = download_motion_capture_with_http_info(motion_capture_id, opts)
|
1205
|
+
data
|
1206
|
+
end
|
1207
|
+
|
1208
|
+
# Download motion capture
|
1209
|
+
# Motion captures are downloaded using this endpoint.
|
1210
|
+
# @param motion_capture_id [String] The motion capture's unique identifier.
|
1211
|
+
# @param [Hash] opts the optional parameters
|
1212
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
1213
|
+
def download_motion_capture_with_http_info(motion_capture_id, opts = {})
|
1214
|
+
if @api_client.config.debugging
|
1215
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.download_motion_capture ...'
|
1216
|
+
end
|
1217
|
+
# verify the required parameter 'motion_capture_id' is set
|
1218
|
+
if @api_client.config.client_side_validation && motion_capture_id.nil?
|
1219
|
+
fail ArgumentError, "Missing the required parameter 'motion_capture_id' when calling DefaultApi.download_motion_capture"
|
1220
|
+
end
|
1221
|
+
# resource path
|
1222
|
+
local_var_path = '/motion_captures/{motion_capture_id}/download'.sub('{' + 'motion_capture_id' + '}', CGI.escape(motion_capture_id.to_s))
|
1223
|
+
|
1224
|
+
# query parameters
|
1225
|
+
query_params = opts[:query_params] || {}
|
1226
|
+
|
1227
|
+
# header parameters
|
1228
|
+
header_params = opts[:header_params] || {}
|
1229
|
+
# HTTP header 'Accept' (if needed)
|
1230
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*', 'application/json'])
|
1231
|
+
|
1232
|
+
# form parameters
|
1233
|
+
form_params = opts[:form_params] || {}
|
1234
|
+
|
1235
|
+
# http body (model)
|
1236
|
+
post_body = opts[:debug_body]
|
1237
|
+
|
1238
|
+
# return_type
|
1239
|
+
return_type = opts[:debug_return_type] || 'File'
|
1240
|
+
|
1241
|
+
# auth_names
|
1242
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1243
|
+
|
1244
|
+
new_options = opts.merge(
|
1245
|
+
:operation => :"DefaultApi.download_motion_capture",
|
1246
|
+
:header_params => header_params,
|
1247
|
+
:query_params => query_params,
|
1248
|
+
:form_params => form_params,
|
1249
|
+
:body => post_body,
|
1250
|
+
:auth_names => auth_names,
|
1251
|
+
:return_type => return_type
|
1252
|
+
)
|
1253
|
+
|
1254
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1255
|
+
if @api_client.config.debugging
|
1256
|
+
@api_client.config.logger.debug "API called: DefaultApi#download_motion_capture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1257
|
+
end
|
1258
|
+
return data, status_code, headers
|
1259
|
+
end
|
1260
|
+
|
1261
|
+
# Download motion capture frame
|
1262
|
+
# Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
|
1263
|
+
# @param motion_capture_id [String] The motion capture's unique identifier.
|
1264
|
+
# @param [Hash] opts the optional parameters
|
1265
|
+
# @return [File]
|
1266
|
+
def download_motion_capture_frame(motion_capture_id, opts = {})
|
1267
|
+
data, _status_code, _headers = download_motion_capture_frame_with_http_info(motion_capture_id, opts)
|
1268
|
+
data
|
1269
|
+
end
|
1270
|
+
|
1271
|
+
# Download motion capture frame
|
1272
|
+
# Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
|
1273
|
+
# @param motion_capture_id [String] The motion capture's unique identifier.
|
1274
|
+
# @param [Hash] opts the optional parameters
|
1275
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
1276
|
+
def download_motion_capture_frame_with_http_info(motion_capture_id, opts = {})
|
1277
|
+
if @api_client.config.debugging
|
1278
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.download_motion_capture_frame ...'
|
1279
|
+
end
|
1280
|
+
# verify the required parameter 'motion_capture_id' is set
|
1281
|
+
if @api_client.config.client_side_validation && motion_capture_id.nil?
|
1282
|
+
fail ArgumentError, "Missing the required parameter 'motion_capture_id' when calling DefaultApi.download_motion_capture_frame"
|
1283
|
+
end
|
1284
|
+
# resource path
|
1285
|
+
local_var_path = '/motion_captures/{motion_capture_id}/frame'.sub('{' + 'motion_capture_id' + '}', CGI.escape(motion_capture_id.to_s))
|
1286
|
+
|
1287
|
+
# query parameters
|
1288
|
+
query_params = opts[:query_params] || {}
|
1289
|
+
|
1290
|
+
# header parameters
|
1291
|
+
header_params = opts[:header_params] || {}
|
1292
|
+
# HTTP header 'Accept' (if needed)
|
1293
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*', 'application/json'])
|
1294
|
+
|
1295
|
+
# form parameters
|
1296
|
+
form_params = opts[:form_params] || {}
|
1297
|
+
|
1298
|
+
# http body (model)
|
1299
|
+
post_body = opts[:debug_body]
|
1300
|
+
|
1301
|
+
# return_type
|
1302
|
+
return_type = opts[:debug_return_type] || 'File'
|
1303
|
+
|
1304
|
+
# auth_names
|
1305
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1306
|
+
|
1307
|
+
new_options = opts.merge(
|
1308
|
+
:operation => :"DefaultApi.download_motion_capture_frame",
|
1309
|
+
:header_params => header_params,
|
1310
|
+
:query_params => query_params,
|
1311
|
+
:form_params => form_params,
|
1312
|
+
:body => post_body,
|
1313
|
+
:auth_names => auth_names,
|
1314
|
+
:return_type => return_type
|
1315
|
+
)
|
1316
|
+
|
1317
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1318
|
+
if @api_client.config.debugging
|
1319
|
+
@api_client.config.logger.debug "API called: DefaultApi#download_motion_capture_frame\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1320
|
+
end
|
1321
|
+
return data, status_code, headers
|
1322
|
+
end
|
1323
|
+
|
1324
|
+
# Retrieve Workflow Run Evidence Summary File
|
1325
|
+
# Retrieves the signed evidence file for the designated Workflow Run
|
1326
|
+
# @param workflow_run_id [String] Workflow Run ID
|
1327
|
+
# @param [Hash] opts the optional parameters
|
1328
|
+
# @return [File]
|
1329
|
+
def download_signed_evidence_file(workflow_run_id, opts = {})
|
1330
|
+
data, _status_code, _headers = download_signed_evidence_file_with_http_info(workflow_run_id, opts)
|
1331
|
+
data
|
1332
|
+
end
|
1333
|
+
|
1334
|
+
# Retrieve Workflow Run Evidence Summary File
|
1335
|
+
# Retrieves the signed evidence file for the designated Workflow Run
|
1336
|
+
# @param workflow_run_id [String] Workflow Run ID
|
1337
|
+
# @param [Hash] opts the optional parameters
|
1338
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
1339
|
+
def download_signed_evidence_file_with_http_info(workflow_run_id, opts = {})
|
1340
|
+
if @api_client.config.debugging
|
1341
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.download_signed_evidence_file ...'
|
1342
|
+
end
|
1343
|
+
# verify the required parameter 'workflow_run_id' is set
|
1344
|
+
if @api_client.config.client_side_validation && workflow_run_id.nil?
|
1345
|
+
fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.download_signed_evidence_file"
|
1346
|
+
end
|
1347
|
+
# resource path
|
1348
|
+
local_var_path = '/workflow_runs/{workflow_run_id}/signed_evidence_file'.sub('{' + 'workflow_run_id' + '}', CGI.escape(workflow_run_id.to_s))
|
1349
|
+
|
1350
|
+
# query parameters
|
1351
|
+
query_params = opts[:query_params] || {}
|
1352
|
+
|
1353
|
+
# header parameters
|
1354
|
+
header_params = opts[:header_params] || {}
|
1355
|
+
# HTTP header 'Accept' (if needed)
|
1356
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
|
1357
|
+
|
1358
|
+
# form parameters
|
1359
|
+
form_params = opts[:form_params] || {}
|
1360
|
+
|
1361
|
+
# http body (model)
|
1362
|
+
post_body = opts[:debug_body]
|
1363
|
+
|
1364
|
+
# return_type
|
1365
|
+
return_type = opts[:debug_return_type] || 'File'
|
1366
|
+
|
1367
|
+
# auth_names
|
1368
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1369
|
+
|
1370
|
+
new_options = opts.merge(
|
1371
|
+
:operation => :"DefaultApi.download_signed_evidence_file",
|
1372
|
+
:header_params => header_params,
|
1373
|
+
:query_params => query_params,
|
1374
|
+
:form_params => form_params,
|
1375
|
+
:body => post_body,
|
1376
|
+
:auth_names => auth_names,
|
1377
|
+
:return_type => return_type
|
1378
|
+
)
|
1379
|
+
|
1380
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1381
|
+
if @api_client.config.debugging
|
1382
|
+
@api_client.config.logger.debug "API called: DefaultApi#download_signed_evidence_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1383
|
+
end
|
1384
|
+
return data, status_code, headers
|
1385
|
+
end
|
1386
|
+
|
1387
|
+
# Autofill
|
1388
|
+
# Extract information from a document
|
1389
|
+
# @param extract_request [ExtractRequest]
|
1390
|
+
# @param [Hash] opts the optional parameters
|
1391
|
+
# @return [Extraction]
|
1392
|
+
def extract(extract_request, opts = {})
|
1393
|
+
data, _status_code, _headers = extract_with_http_info(extract_request, opts)
|
1394
|
+
data
|
1395
|
+
end
|
1396
|
+
|
1397
|
+
# Autofill
|
1398
|
+
# Extract information from a document
|
1399
|
+
# @param extract_request [ExtractRequest]
|
1400
|
+
# @param [Hash] opts the optional parameters
|
1401
|
+
# @return [Array<(Extraction, Integer, Hash)>] Extraction data, response status code and response headers
|
1402
|
+
def extract_with_http_info(extract_request, opts = {})
|
1403
|
+
if @api_client.config.debugging
|
1404
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.extract ...'
|
1405
|
+
end
|
1406
|
+
# verify the required parameter 'extract_request' is set
|
1407
|
+
if @api_client.config.client_side_validation && extract_request.nil?
|
1408
|
+
fail ArgumentError, "Missing the required parameter 'extract_request' when calling DefaultApi.extract"
|
1409
|
+
end
|
1410
|
+
# resource path
|
1411
|
+
local_var_path = '/extractions'
|
1412
|
+
|
1413
|
+
# query parameters
|
1414
|
+
query_params = opts[:query_params] || {}
|
1415
|
+
|
1416
|
+
# header parameters
|
1417
|
+
header_params = opts[:header_params] || {}
|
1418
|
+
# HTTP header 'Accept' (if needed)
|
1419
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1420
|
+
# HTTP header 'Content-Type'
|
1421
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
1422
|
+
if !content_type.nil?
|
1423
|
+
header_params['Content-Type'] = content_type
|
1424
|
+
end
|
1425
|
+
|
1426
|
+
# form parameters
|
1427
|
+
form_params = opts[:form_params] || {}
|
1428
|
+
|
1429
|
+
# http body (model)
|
1430
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(extract_request)
|
1431
|
+
|
1432
|
+
# return_type
|
1433
|
+
return_type = opts[:debug_return_type] || 'Extraction'
|
1434
|
+
|
1435
|
+
# auth_names
|
1436
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1437
|
+
|
1438
|
+
new_options = opts.merge(
|
1439
|
+
:operation => :"DefaultApi.extract",
|
1440
|
+
:header_params => header_params,
|
1441
|
+
:query_params => query_params,
|
1442
|
+
:form_params => form_params,
|
1443
|
+
:body => post_body,
|
1444
|
+
:auth_names => auth_names,
|
1445
|
+
:return_type => return_type
|
1446
|
+
)
|
1447
|
+
|
1448
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1449
|
+
if @api_client.config.debugging
|
1450
|
+
@api_client.config.logger.debug "API called: DefaultApi#extract\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1451
|
+
end
|
1452
|
+
return data, status_code, headers
|
1453
|
+
end
|
1454
|
+
|
1455
|
+
# Address Picker
|
1456
|
+
# Search for addresses by postcode
|
1457
|
+
# @param postcode [String]
|
1458
|
+
# @param [Hash] opts the optional parameters
|
1459
|
+
# @return [AddressesList]
|
1460
|
+
def find_addresses(postcode, opts = {})
|
1461
|
+
data, _status_code, _headers = find_addresses_with_http_info(postcode, opts)
|
1462
|
+
data
|
1463
|
+
end
|
1464
|
+
|
1465
|
+
# Address Picker
|
1466
|
+
# Search for addresses by postcode
|
1467
|
+
# @param postcode [String]
|
1468
|
+
# @param [Hash] opts the optional parameters
|
1469
|
+
# @return [Array<(AddressesList, Integer, Hash)>] AddressesList data, response status code and response headers
|
1470
|
+
def find_addresses_with_http_info(postcode, opts = {})
|
1471
|
+
if @api_client.config.debugging
|
1472
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_addresses ...'
|
1473
|
+
end
|
1474
|
+
# verify the required parameter 'postcode' is set
|
1475
|
+
if @api_client.config.client_side_validation && postcode.nil?
|
1476
|
+
fail ArgumentError, "Missing the required parameter 'postcode' when calling DefaultApi.find_addresses"
|
1477
|
+
end
|
1478
|
+
# resource path
|
1479
|
+
local_var_path = '/addresses/pick'
|
1480
|
+
|
1481
|
+
# query parameters
|
1482
|
+
query_params = opts[:query_params] || {}
|
1483
|
+
query_params[:'postcode'] = postcode
|
1484
|
+
|
1485
|
+
# header parameters
|
1486
|
+
header_params = opts[:header_params] || {}
|
1487
|
+
# HTTP header 'Accept' (if needed)
|
1488
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1489
|
+
|
1490
|
+
# form parameters
|
1491
|
+
form_params = opts[:form_params] || {}
|
1492
|
+
|
1493
|
+
# http body (model)
|
1494
|
+
post_body = opts[:debug_body]
|
1495
|
+
|
1496
|
+
# return_type
|
1497
|
+
return_type = opts[:debug_return_type] || 'AddressesList'
|
1498
|
+
|
1499
|
+
# auth_names
|
1500
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1501
|
+
|
1502
|
+
new_options = opts.merge(
|
1503
|
+
:operation => :"DefaultApi.find_addresses",
|
1504
|
+
:header_params => header_params,
|
1505
|
+
:query_params => query_params,
|
1506
|
+
:form_params => form_params,
|
1507
|
+
:body => post_body,
|
1508
|
+
:auth_names => auth_names,
|
1509
|
+
:return_type => return_type
|
1510
|
+
)
|
1511
|
+
|
1512
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1513
|
+
if @api_client.config.debugging
|
1514
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1515
|
+
end
|
1516
|
+
return data, status_code, headers
|
1517
|
+
end
|
1518
|
+
|
1519
|
+
# Retrieve Applicant
|
1520
|
+
# Retrieves a single applicant. Returns an applicant object.
|
1521
|
+
# @param applicant_id [String]
|
1522
|
+
# @param [Hash] opts the optional parameters
|
1523
|
+
# @return [Applicant]
|
1524
|
+
def find_applicant(applicant_id, opts = {})
|
1525
|
+
data, _status_code, _headers = find_applicant_with_http_info(applicant_id, opts)
|
1526
|
+
data
|
1527
|
+
end
|
1528
|
+
|
1529
|
+
# Retrieve Applicant
|
1530
|
+
# Retrieves a single applicant. Returns an applicant object.
|
1531
|
+
# @param applicant_id [String]
|
1532
|
+
# @param [Hash] opts the optional parameters
|
1533
|
+
# @return [Array<(Applicant, Integer, Hash)>] Applicant data, response status code and response headers
|
1534
|
+
def find_applicant_with_http_info(applicant_id, opts = {})
|
1535
|
+
if @api_client.config.debugging
|
1536
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_applicant ...'
|
1537
|
+
end
|
1538
|
+
# verify the required parameter 'applicant_id' is set
|
1539
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
1540
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.find_applicant"
|
1541
|
+
end
|
1542
|
+
# resource path
|
1543
|
+
local_var_path = '/applicants/{applicant_id}'.sub('{' + 'applicant_id' + '}', CGI.escape(applicant_id.to_s))
|
1544
|
+
|
1545
|
+
# query parameters
|
1546
|
+
query_params = opts[:query_params] || {}
|
1547
|
+
|
1548
|
+
# header parameters
|
1549
|
+
header_params = opts[:header_params] || {}
|
1550
|
+
# HTTP header 'Accept' (if needed)
|
1551
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1552
|
+
|
1553
|
+
# form parameters
|
1554
|
+
form_params = opts[:form_params] || {}
|
1555
|
+
|
1556
|
+
# http body (model)
|
1557
|
+
post_body = opts[:debug_body]
|
1558
|
+
|
1559
|
+
# return_type
|
1560
|
+
return_type = opts[:debug_return_type] || 'Applicant'
|
1561
|
+
|
1562
|
+
# auth_names
|
1563
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1564
|
+
|
1565
|
+
new_options = opts.merge(
|
1566
|
+
:operation => :"DefaultApi.find_applicant",
|
1567
|
+
:header_params => header_params,
|
1568
|
+
:query_params => query_params,
|
1569
|
+
:form_params => form_params,
|
1570
|
+
:body => post_body,
|
1571
|
+
:auth_names => auth_names,
|
1572
|
+
:return_type => return_type
|
1573
|
+
)
|
1574
|
+
|
1575
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1576
|
+
if @api_client.config.debugging
|
1577
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_applicant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1578
|
+
end
|
1579
|
+
return data, status_code, headers
|
1580
|
+
end
|
1581
|
+
|
1582
|
+
# Retrieve a Check
|
1583
|
+
# Retrieves a single check. Returns a check object.
|
1584
|
+
# @param check_id [String]
|
1585
|
+
# @param [Hash] opts the optional parameters
|
1586
|
+
# @return [Check]
|
1587
|
+
def find_check(check_id, opts = {})
|
1588
|
+
data, _status_code, _headers = find_check_with_http_info(check_id, opts)
|
1589
|
+
data
|
1590
|
+
end
|
1591
|
+
|
1592
|
+
# Retrieve a Check
|
1593
|
+
# Retrieves a single check. Returns a check object.
|
1594
|
+
# @param check_id [String]
|
1595
|
+
# @param [Hash] opts the optional parameters
|
1596
|
+
# @return [Array<(Check, Integer, Hash)>] Check data, response status code and response headers
|
1597
|
+
def find_check_with_http_info(check_id, opts = {})
|
1598
|
+
if @api_client.config.debugging
|
1599
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_check ...'
|
1600
|
+
end
|
1601
|
+
# verify the required parameter 'check_id' is set
|
1602
|
+
if @api_client.config.client_side_validation && check_id.nil?
|
1603
|
+
fail ArgumentError, "Missing the required parameter 'check_id' when calling DefaultApi.find_check"
|
1604
|
+
end
|
1605
|
+
# resource path
|
1606
|
+
local_var_path = '/checks/{check_id}'.sub('{' + 'check_id' + '}', CGI.escape(check_id.to_s))
|
1607
|
+
|
1608
|
+
# query parameters
|
1609
|
+
query_params = opts[:query_params] || {}
|
1610
|
+
|
1611
|
+
# header parameters
|
1612
|
+
header_params = opts[:header_params] || {}
|
1613
|
+
# HTTP header 'Accept' (if needed)
|
1614
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1615
|
+
|
1616
|
+
# form parameters
|
1617
|
+
form_params = opts[:form_params] || {}
|
1618
|
+
|
1619
|
+
# http body (model)
|
1620
|
+
post_body = opts[:debug_body]
|
1621
|
+
|
1622
|
+
# return_type
|
1623
|
+
return_type = opts[:debug_return_type] || 'Check'
|
1624
|
+
|
1625
|
+
# auth_names
|
1626
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1627
|
+
|
1628
|
+
new_options = opts.merge(
|
1629
|
+
:operation => :"DefaultApi.find_check",
|
1630
|
+
:header_params => header_params,
|
1631
|
+
:query_params => query_params,
|
1632
|
+
:form_params => form_params,
|
1633
|
+
:body => post_body,
|
1634
|
+
:auth_names => auth_names,
|
1635
|
+
:return_type => return_type
|
1636
|
+
)
|
1637
|
+
|
1638
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1639
|
+
if @api_client.config.debugging
|
1640
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1641
|
+
end
|
1642
|
+
return data, status_code, headers
|
1643
|
+
end
|
1644
|
+
|
1645
|
+
# Retrieve document
|
1646
|
+
# A single document can be retrieved by calling this endpoint with the document's unique identifier.
|
1647
|
+
# @param document_id [String]
|
1648
|
+
# @param [Hash] opts the optional parameters
|
1649
|
+
# @return [Document]
|
1650
|
+
def find_document(document_id, opts = {})
|
1651
|
+
data, _status_code, _headers = find_document_with_http_info(document_id, opts)
|
1652
|
+
data
|
1653
|
+
end
|
1654
|
+
|
1655
|
+
# Retrieve document
|
1656
|
+
# A single document can be retrieved by calling this endpoint with the document's unique identifier.
|
1657
|
+
# @param document_id [String]
|
1658
|
+
# @param [Hash] opts the optional parameters
|
1659
|
+
# @return [Array<(Document, Integer, Hash)>] Document data, response status code and response headers
|
1660
|
+
def find_document_with_http_info(document_id, opts = {})
|
1661
|
+
if @api_client.config.debugging
|
1662
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_document ...'
|
1663
|
+
end
|
1664
|
+
# verify the required parameter 'document_id' is set
|
1665
|
+
if @api_client.config.client_side_validation && document_id.nil?
|
1666
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling DefaultApi.find_document"
|
1667
|
+
end
|
1668
|
+
# resource path
|
1669
|
+
local_var_path = '/documents/{document_id}'.sub('{' + 'document_id' + '}', CGI.escape(document_id.to_s))
|
1670
|
+
|
1671
|
+
# query parameters
|
1672
|
+
query_params = opts[:query_params] || {}
|
1673
|
+
|
1674
|
+
# header parameters
|
1675
|
+
header_params = opts[:header_params] || {}
|
1676
|
+
# HTTP header 'Accept' (if needed)
|
1677
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1678
|
+
|
1679
|
+
# form parameters
|
1680
|
+
form_params = opts[:form_params] || {}
|
1681
|
+
|
1682
|
+
# http body (model)
|
1683
|
+
post_body = opts[:debug_body]
|
1684
|
+
|
1685
|
+
# return_type
|
1686
|
+
return_type = opts[:debug_return_type] || 'Document'
|
1687
|
+
|
1688
|
+
# auth_names
|
1689
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1690
|
+
|
1691
|
+
new_options = opts.merge(
|
1692
|
+
:operation => :"DefaultApi.find_document",
|
1693
|
+
:header_params => header_params,
|
1694
|
+
:query_params => query_params,
|
1695
|
+
:form_params => form_params,
|
1696
|
+
:body => post_body,
|
1697
|
+
:auth_names => auth_names,
|
1698
|
+
:return_type => return_type
|
1699
|
+
)
|
1700
|
+
|
1701
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1702
|
+
if @api_client.config.debugging
|
1703
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1704
|
+
end
|
1705
|
+
return data, status_code, headers
|
1706
|
+
end
|
1707
|
+
|
1708
|
+
# Retrieve ID photo
|
1709
|
+
# Retrieves a single ID photo. Returns a ID photo object.
|
1710
|
+
# @param id_photo_id [String] The ID photo's unique identifier.
|
1711
|
+
# @param [Hash] opts the optional parameters
|
1712
|
+
# @return [IdPhoto]
|
1713
|
+
def find_id_photo(id_photo_id, opts = {})
|
1714
|
+
data, _status_code, _headers = find_id_photo_with_http_info(id_photo_id, opts)
|
1715
|
+
data
|
1716
|
+
end
|
1717
|
+
|
1718
|
+
# Retrieve ID photo
|
1719
|
+
# Retrieves a single ID photo. Returns a ID photo object.
|
1720
|
+
# @param id_photo_id [String] The ID photo's unique identifier.
|
1721
|
+
# @param [Hash] opts the optional parameters
|
1722
|
+
# @return [Array<(IdPhoto, Integer, Hash)>] IdPhoto data, response status code and response headers
|
1723
|
+
def find_id_photo_with_http_info(id_photo_id, opts = {})
|
1724
|
+
if @api_client.config.debugging
|
1725
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_id_photo ...'
|
1726
|
+
end
|
1727
|
+
# verify the required parameter 'id_photo_id' is set
|
1728
|
+
if @api_client.config.client_side_validation && id_photo_id.nil?
|
1729
|
+
fail ArgumentError, "Missing the required parameter 'id_photo_id' when calling DefaultApi.find_id_photo"
|
1730
|
+
end
|
1731
|
+
# resource path
|
1732
|
+
local_var_path = '/id_photos/{id_photo_id}'.sub('{' + 'id_photo_id' + '}', CGI.escape(id_photo_id.to_s))
|
1733
|
+
|
1734
|
+
# query parameters
|
1735
|
+
query_params = opts[:query_params] || {}
|
1736
|
+
|
1737
|
+
# header parameters
|
1738
|
+
header_params = opts[:header_params] || {}
|
1739
|
+
# HTTP header 'Accept' (if needed)
|
1740
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1741
|
+
|
1742
|
+
# form parameters
|
1743
|
+
form_params = opts[:form_params] || {}
|
1744
|
+
|
1745
|
+
# http body (model)
|
1746
|
+
post_body = opts[:debug_body]
|
1747
|
+
|
1748
|
+
# return_type
|
1749
|
+
return_type = opts[:debug_return_type] || 'IdPhoto'
|
1750
|
+
|
1751
|
+
# auth_names
|
1752
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1753
|
+
|
1754
|
+
new_options = opts.merge(
|
1755
|
+
:operation => :"DefaultApi.find_id_photo",
|
1756
|
+
:header_params => header_params,
|
1757
|
+
:query_params => query_params,
|
1758
|
+
:form_params => form_params,
|
1759
|
+
:body => post_body,
|
1760
|
+
:auth_names => auth_names,
|
1761
|
+
:return_type => return_type
|
1762
|
+
)
|
1763
|
+
|
1764
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1765
|
+
if @api_client.config.debugging
|
1766
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_id_photo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1767
|
+
end
|
1768
|
+
return data, status_code, headers
|
1769
|
+
end
|
1770
|
+
|
1771
|
+
# Retrieve live photo
|
1772
|
+
# Retrieves a single live photo. Returns a live photo object.
|
1773
|
+
# @param live_photo_id [String] The live photo's unique identifier.
|
1774
|
+
# @param [Hash] opts the optional parameters
|
1775
|
+
# @return [LivePhoto]
|
1776
|
+
def find_live_photo(live_photo_id, opts = {})
|
1777
|
+
data, _status_code, _headers = find_live_photo_with_http_info(live_photo_id, opts)
|
1778
|
+
data
|
1779
|
+
end
|
1780
|
+
|
1781
|
+
# Retrieve live photo
|
1782
|
+
# Retrieves a single live photo. Returns a live photo object.
|
1783
|
+
# @param live_photo_id [String] The live photo's unique identifier.
|
1784
|
+
# @param [Hash] opts the optional parameters
|
1785
|
+
# @return [Array<(LivePhoto, Integer, Hash)>] LivePhoto data, response status code and response headers
|
1786
|
+
def find_live_photo_with_http_info(live_photo_id, opts = {})
|
1787
|
+
if @api_client.config.debugging
|
1788
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_live_photo ...'
|
1789
|
+
end
|
1790
|
+
# verify the required parameter 'live_photo_id' is set
|
1791
|
+
if @api_client.config.client_side_validation && live_photo_id.nil?
|
1792
|
+
fail ArgumentError, "Missing the required parameter 'live_photo_id' when calling DefaultApi.find_live_photo"
|
1793
|
+
end
|
1794
|
+
# resource path
|
1795
|
+
local_var_path = '/live_photos/{live_photo_id}'.sub('{' + 'live_photo_id' + '}', CGI.escape(live_photo_id.to_s))
|
1796
|
+
|
1797
|
+
# query parameters
|
1798
|
+
query_params = opts[:query_params] || {}
|
1799
|
+
|
1800
|
+
# header parameters
|
1801
|
+
header_params = opts[:header_params] || {}
|
1802
|
+
# HTTP header 'Accept' (if needed)
|
1803
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1804
|
+
|
1805
|
+
# form parameters
|
1806
|
+
form_params = opts[:form_params] || {}
|
1807
|
+
|
1808
|
+
# http body (model)
|
1809
|
+
post_body = opts[:debug_body]
|
1810
|
+
|
1811
|
+
# return_type
|
1812
|
+
return_type = opts[:debug_return_type] || 'LivePhoto'
|
1813
|
+
|
1814
|
+
# auth_names
|
1815
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1816
|
+
|
1817
|
+
new_options = opts.merge(
|
1818
|
+
:operation => :"DefaultApi.find_live_photo",
|
1819
|
+
:header_params => header_params,
|
1820
|
+
:query_params => query_params,
|
1821
|
+
:form_params => form_params,
|
1822
|
+
:body => post_body,
|
1823
|
+
:auth_names => auth_names,
|
1824
|
+
:return_type => return_type
|
1825
|
+
)
|
1826
|
+
|
1827
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1828
|
+
if @api_client.config.debugging
|
1829
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_live_photo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1830
|
+
end
|
1831
|
+
return data, status_code, headers
|
1832
|
+
end
|
1833
|
+
|
1834
|
+
# Retrieve live video
|
1835
|
+
# Retrieves a single live video. Returns the corresponding live video object.
|
1836
|
+
# @param live_video_id [String] The live video's unique identifier.
|
1837
|
+
# @param [Hash] opts the optional parameters
|
1838
|
+
# @return [LiveVideo]
|
1839
|
+
def find_live_video(live_video_id, opts = {})
|
1840
|
+
data, _status_code, _headers = find_live_video_with_http_info(live_video_id, opts)
|
1841
|
+
data
|
1842
|
+
end
|
1843
|
+
|
1844
|
+
# Retrieve live video
|
1845
|
+
# Retrieves a single live video. Returns the corresponding live video object.
|
1846
|
+
# @param live_video_id [String] The live video's unique identifier.
|
1847
|
+
# @param [Hash] opts the optional parameters
|
1848
|
+
# @return [Array<(LiveVideo, Integer, Hash)>] LiveVideo data, response status code and response headers
|
1849
|
+
def find_live_video_with_http_info(live_video_id, opts = {})
|
1850
|
+
if @api_client.config.debugging
|
1851
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_live_video ...'
|
1852
|
+
end
|
1853
|
+
# verify the required parameter 'live_video_id' is set
|
1854
|
+
if @api_client.config.client_side_validation && live_video_id.nil?
|
1855
|
+
fail ArgumentError, "Missing the required parameter 'live_video_id' when calling DefaultApi.find_live_video"
|
1856
|
+
end
|
1857
|
+
# resource path
|
1858
|
+
local_var_path = '/live_videos/{live_video_id}'.sub('{' + 'live_video_id' + '}', CGI.escape(live_video_id.to_s))
|
1859
|
+
|
1860
|
+
# query parameters
|
1861
|
+
query_params = opts[:query_params] || {}
|
1862
|
+
|
1863
|
+
# header parameters
|
1864
|
+
header_params = opts[:header_params] || {}
|
1865
|
+
# HTTP header 'Accept' (if needed)
|
1866
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1867
|
+
|
1868
|
+
# form parameters
|
1869
|
+
form_params = opts[:form_params] || {}
|
1870
|
+
|
1871
|
+
# http body (model)
|
1872
|
+
post_body = opts[:debug_body]
|
1873
|
+
|
1874
|
+
# return_type
|
1875
|
+
return_type = opts[:debug_return_type] || 'LiveVideo'
|
1876
|
+
|
1877
|
+
# auth_names
|
1878
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1879
|
+
|
1880
|
+
new_options = opts.merge(
|
1881
|
+
:operation => :"DefaultApi.find_live_video",
|
1882
|
+
:header_params => header_params,
|
1883
|
+
:query_params => query_params,
|
1884
|
+
:form_params => form_params,
|
1885
|
+
:body => post_body,
|
1886
|
+
:auth_names => auth_names,
|
1887
|
+
:return_type => return_type
|
1888
|
+
)
|
1889
|
+
|
1890
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1891
|
+
if @api_client.config.debugging
|
1892
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_live_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1893
|
+
end
|
1894
|
+
return data, status_code, headers
|
1895
|
+
end
|
1896
|
+
|
1897
|
+
# Retrieve motion capture
|
1898
|
+
# Retrieves a single motion capture. Returns the corresponding motion capture object.
|
1899
|
+
# @param motion_capture_id [String] The motion capture's unique identifier.
|
1900
|
+
# @param [Hash] opts the optional parameters
|
1901
|
+
# @return [MotionCapture]
|
1902
|
+
def find_motion_capture(motion_capture_id, opts = {})
|
1903
|
+
data, _status_code, _headers = find_motion_capture_with_http_info(motion_capture_id, opts)
|
1904
|
+
data
|
1905
|
+
end
|
1906
|
+
|
1907
|
+
# Retrieve motion capture
|
1908
|
+
# Retrieves a single motion capture. Returns the corresponding motion capture object.
|
1909
|
+
# @param motion_capture_id [String] The motion capture's unique identifier.
|
1910
|
+
# @param [Hash] opts the optional parameters
|
1911
|
+
# @return [Array<(MotionCapture, Integer, Hash)>] MotionCapture data, response status code and response headers
|
1912
|
+
def find_motion_capture_with_http_info(motion_capture_id, opts = {})
|
1913
|
+
if @api_client.config.debugging
|
1914
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_motion_capture ...'
|
1915
|
+
end
|
1916
|
+
# verify the required parameter 'motion_capture_id' is set
|
1917
|
+
if @api_client.config.client_side_validation && motion_capture_id.nil?
|
1918
|
+
fail ArgumentError, "Missing the required parameter 'motion_capture_id' when calling DefaultApi.find_motion_capture"
|
1919
|
+
end
|
1920
|
+
# resource path
|
1921
|
+
local_var_path = '/motion_captures/{motion_capture_id}'.sub('{' + 'motion_capture_id' + '}', CGI.escape(motion_capture_id.to_s))
|
1922
|
+
|
1923
|
+
# query parameters
|
1924
|
+
query_params = opts[:query_params] || {}
|
1925
|
+
|
1926
|
+
# header parameters
|
1927
|
+
header_params = opts[:header_params] || {}
|
1928
|
+
# HTTP header 'Accept' (if needed)
|
1929
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1930
|
+
|
1931
|
+
# form parameters
|
1932
|
+
form_params = opts[:form_params] || {}
|
1933
|
+
|
1934
|
+
# http body (model)
|
1935
|
+
post_body = opts[:debug_body]
|
1936
|
+
|
1937
|
+
# return_type
|
1938
|
+
return_type = opts[:debug_return_type] || 'MotionCapture'
|
1939
|
+
|
1940
|
+
# auth_names
|
1941
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
1942
|
+
|
1943
|
+
new_options = opts.merge(
|
1944
|
+
:operation => :"DefaultApi.find_motion_capture",
|
1945
|
+
:header_params => header_params,
|
1946
|
+
:query_params => query_params,
|
1947
|
+
:form_params => form_params,
|
1948
|
+
:body => post_body,
|
1949
|
+
:auth_names => auth_names,
|
1950
|
+
:return_type => return_type
|
1951
|
+
)
|
1952
|
+
|
1953
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1954
|
+
if @api_client.config.debugging
|
1955
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_motion_capture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1956
|
+
end
|
1957
|
+
return data, status_code, headers
|
1958
|
+
end
|
1959
|
+
|
1960
|
+
# Retrieve report
|
1961
|
+
# A single report can be retrieved using this endpoint with the corresponding unique identifier.
|
1962
|
+
# @param report_id [String]
|
1963
|
+
# @param [Hash] opts the optional parameters
|
1964
|
+
# @return [Report]
|
1965
|
+
def find_report(report_id, opts = {})
|
1966
|
+
data, _status_code, _headers = find_report_with_http_info(report_id, opts)
|
1967
|
+
data
|
1968
|
+
end
|
1969
|
+
|
1970
|
+
# Retrieve report
|
1971
|
+
# A single report can be retrieved using this endpoint with the corresponding unique identifier.
|
1972
|
+
# @param report_id [String]
|
1973
|
+
# @param [Hash] opts the optional parameters
|
1974
|
+
# @return [Array<(Report, Integer, Hash)>] Report data, response status code and response headers
|
1975
|
+
def find_report_with_http_info(report_id, opts = {})
|
1976
|
+
if @api_client.config.debugging
|
1977
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_report ...'
|
1978
|
+
end
|
1979
|
+
# verify the required parameter 'report_id' is set
|
1980
|
+
if @api_client.config.client_side_validation && report_id.nil?
|
1981
|
+
fail ArgumentError, "Missing the required parameter 'report_id' when calling DefaultApi.find_report"
|
1982
|
+
end
|
1983
|
+
# resource path
|
1984
|
+
local_var_path = '/reports/{report_id}'.sub('{' + 'report_id' + '}', CGI.escape(report_id.to_s))
|
1985
|
+
|
1986
|
+
# query parameters
|
1987
|
+
query_params = opts[:query_params] || {}
|
1988
|
+
|
1989
|
+
# header parameters
|
1990
|
+
header_params = opts[:header_params] || {}
|
1991
|
+
# HTTP header 'Accept' (if needed)
|
1992
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1993
|
+
|
1994
|
+
# form parameters
|
1995
|
+
form_params = opts[:form_params] || {}
|
1996
|
+
|
1997
|
+
# http body (model)
|
1998
|
+
post_body = opts[:debug_body]
|
1999
|
+
|
2000
|
+
# return_type
|
2001
|
+
return_type = opts[:debug_return_type] || 'Report'
|
2002
|
+
|
2003
|
+
# auth_names
|
2004
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2005
|
+
|
2006
|
+
new_options = opts.merge(
|
2007
|
+
:operation => :"DefaultApi.find_report",
|
2008
|
+
:header_params => header_params,
|
2009
|
+
:query_params => query_params,
|
2010
|
+
:form_params => form_params,
|
2011
|
+
:body => post_body,
|
2012
|
+
:auth_names => auth_names,
|
2013
|
+
:return_type => return_type
|
2014
|
+
)
|
2015
|
+
|
2016
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2017
|
+
if @api_client.config.debugging
|
2018
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2019
|
+
end
|
2020
|
+
return data, status_code, headers
|
2021
|
+
end
|
2022
|
+
|
2023
|
+
# Retrieve Task
|
2024
|
+
# A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
|
2025
|
+
# @param workflow_run_id [String] The unique identifier of the Workflow Run to which the Task belongs.
|
2026
|
+
# @param task_id [String] The identifier of the Task you want to retrieve.
|
2027
|
+
# @param [Hash] opts the optional parameters
|
2028
|
+
# @return [Task]
|
2029
|
+
def find_task(workflow_run_id, task_id, opts = {})
|
2030
|
+
data, _status_code, _headers = find_task_with_http_info(workflow_run_id, task_id, opts)
|
2031
|
+
data
|
2032
|
+
end
|
2033
|
+
|
2034
|
+
# Retrieve Task
|
2035
|
+
# A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
|
2036
|
+
# @param workflow_run_id [String] The unique identifier of the Workflow Run to which the Task belongs.
|
2037
|
+
# @param task_id [String] The identifier of the Task you want to retrieve.
|
2038
|
+
# @param [Hash] opts the optional parameters
|
2039
|
+
# @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers
|
2040
|
+
def find_task_with_http_info(workflow_run_id, task_id, opts = {})
|
2041
|
+
if @api_client.config.debugging
|
2042
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_task ...'
|
2043
|
+
end
|
2044
|
+
# verify the required parameter 'workflow_run_id' is set
|
2045
|
+
if @api_client.config.client_side_validation && workflow_run_id.nil?
|
2046
|
+
fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.find_task"
|
2047
|
+
end
|
2048
|
+
# verify the required parameter 'task_id' is set
|
2049
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
2050
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling DefaultApi.find_task"
|
2051
|
+
end
|
2052
|
+
# resource path
|
2053
|
+
local_var_path = '/workflow_runs/{workflow_run_id}/tasks/{task_id}'.sub('{' + 'workflow_run_id' + '}', CGI.escape(workflow_run_id.to_s)).sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
2054
|
+
|
2055
|
+
# query parameters
|
2056
|
+
query_params = opts[:query_params] || {}
|
2057
|
+
|
2058
|
+
# header parameters
|
2059
|
+
header_params = opts[:header_params] || {}
|
2060
|
+
# HTTP header 'Accept' (if needed)
|
2061
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2062
|
+
|
2063
|
+
# form parameters
|
2064
|
+
form_params = opts[:form_params] || {}
|
2065
|
+
|
2066
|
+
# http body (model)
|
2067
|
+
post_body = opts[:debug_body]
|
2068
|
+
|
2069
|
+
# return_type
|
2070
|
+
return_type = opts[:debug_return_type] || 'Task'
|
2071
|
+
|
2072
|
+
# auth_names
|
2073
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2074
|
+
|
2075
|
+
new_options = opts.merge(
|
2076
|
+
:operation => :"DefaultApi.find_task",
|
2077
|
+
:header_params => header_params,
|
2078
|
+
:query_params => query_params,
|
2079
|
+
:form_params => form_params,
|
2080
|
+
:body => post_body,
|
2081
|
+
:auth_names => auth_names,
|
2082
|
+
:return_type => return_type
|
2083
|
+
)
|
2084
|
+
|
2085
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2086
|
+
if @api_client.config.debugging
|
2087
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2088
|
+
end
|
2089
|
+
return data, status_code, headers
|
2090
|
+
end
|
2091
|
+
|
2092
|
+
# Retrieve Timeline File for Workflow Run
|
2093
|
+
# Retrieves the Timeline File for the designated Workflow Run.
|
2094
|
+
# @param workflow_run_id [String] The unique identifier of the Workflow Run.
|
2095
|
+
# @param timeline_file_id [String] The unique identifier for the Timefile File.
|
2096
|
+
# @param [Hash] opts the optional parameters
|
2097
|
+
# @return [File]
|
2098
|
+
def find_timeline_file(workflow_run_id, timeline_file_id, opts = {})
|
2099
|
+
data, _status_code, _headers = find_timeline_file_with_http_info(workflow_run_id, timeline_file_id, opts)
|
2100
|
+
data
|
2101
|
+
end
|
2102
|
+
|
2103
|
+
# Retrieve Timeline File for Workflow Run
|
2104
|
+
# Retrieves the Timeline File for the designated Workflow Run.
|
2105
|
+
# @param workflow_run_id [String] The unique identifier of the Workflow Run.
|
2106
|
+
# @param timeline_file_id [String] The unique identifier for the Timefile File.
|
2107
|
+
# @param [Hash] opts the optional parameters
|
2108
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
2109
|
+
def find_timeline_file_with_http_info(workflow_run_id, timeline_file_id, opts = {})
|
2110
|
+
if @api_client.config.debugging
|
2111
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_timeline_file ...'
|
2112
|
+
end
|
2113
|
+
# verify the required parameter 'workflow_run_id' is set
|
2114
|
+
if @api_client.config.client_side_validation && workflow_run_id.nil?
|
2115
|
+
fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.find_timeline_file"
|
2116
|
+
end
|
2117
|
+
# verify the required parameter 'timeline_file_id' is set
|
2118
|
+
if @api_client.config.client_side_validation && timeline_file_id.nil?
|
2119
|
+
fail ArgumentError, "Missing the required parameter 'timeline_file_id' when calling DefaultApi.find_timeline_file"
|
2120
|
+
end
|
2121
|
+
# resource path
|
2122
|
+
local_var_path = '/workflow_runs/{workflow_run_id}/timeline_file/{timeline_file_id}'.sub('{' + 'workflow_run_id' + '}', CGI.escape(workflow_run_id.to_s)).sub('{' + 'timeline_file_id' + '}', CGI.escape(timeline_file_id.to_s))
|
2123
|
+
|
2124
|
+
# query parameters
|
2125
|
+
query_params = opts[:query_params] || {}
|
2126
|
+
|
2127
|
+
# header parameters
|
2128
|
+
header_params = opts[:header_params] || {}
|
2129
|
+
# HTTP header 'Accept' (if needed)
|
2130
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
|
2131
|
+
|
2132
|
+
# form parameters
|
2133
|
+
form_params = opts[:form_params] || {}
|
2134
|
+
|
2135
|
+
# http body (model)
|
2136
|
+
post_body = opts[:debug_body]
|
2137
|
+
|
2138
|
+
# return_type
|
2139
|
+
return_type = opts[:debug_return_type] || 'File'
|
2140
|
+
|
2141
|
+
# auth_names
|
2142
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2143
|
+
|
2144
|
+
new_options = opts.merge(
|
2145
|
+
:operation => :"DefaultApi.find_timeline_file",
|
2146
|
+
:header_params => header_params,
|
2147
|
+
:query_params => query_params,
|
2148
|
+
:form_params => form_params,
|
2149
|
+
:body => post_body,
|
2150
|
+
:auth_names => auth_names,
|
2151
|
+
:return_type => return_type
|
2152
|
+
)
|
2153
|
+
|
2154
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2155
|
+
if @api_client.config.debugging
|
2156
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_timeline_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2157
|
+
end
|
2158
|
+
return data, status_code, headers
|
2159
|
+
end
|
2160
|
+
|
2161
|
+
# Retrieve monitor
|
2162
|
+
# Retrieves a single monitor
|
2163
|
+
# @param monitor_id [String] The watchlist monitor's unique identifier.
|
2164
|
+
# @param [Hash] opts the optional parameters
|
2165
|
+
# @return [WatchlistMonitor]
|
2166
|
+
def find_watchlist_monitor(monitor_id, opts = {})
|
2167
|
+
data, _status_code, _headers = find_watchlist_monitor_with_http_info(monitor_id, opts)
|
2168
|
+
data
|
2169
|
+
end
|
2170
|
+
|
2171
|
+
# Retrieve monitor
|
2172
|
+
# Retrieves a single monitor
|
2173
|
+
# @param monitor_id [String] The watchlist monitor's unique identifier.
|
2174
|
+
# @param [Hash] opts the optional parameters
|
2175
|
+
# @return [Array<(WatchlistMonitor, Integer, Hash)>] WatchlistMonitor data, response status code and response headers
|
2176
|
+
def find_watchlist_monitor_with_http_info(monitor_id, opts = {})
|
2177
|
+
if @api_client.config.debugging
|
2178
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_watchlist_monitor ...'
|
2179
|
+
end
|
2180
|
+
# verify the required parameter 'monitor_id' is set
|
2181
|
+
if @api_client.config.client_side_validation && monitor_id.nil?
|
2182
|
+
fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DefaultApi.find_watchlist_monitor"
|
2183
|
+
end
|
2184
|
+
# resource path
|
2185
|
+
local_var_path = '/watchlist_monitors/{monitor_id}'.sub('{' + 'monitor_id' + '}', CGI.escape(monitor_id.to_s))
|
2186
|
+
|
2187
|
+
# query parameters
|
2188
|
+
query_params = opts[:query_params] || {}
|
2189
|
+
|
2190
|
+
# header parameters
|
2191
|
+
header_params = opts[:header_params] || {}
|
2192
|
+
# HTTP header 'Accept' (if needed)
|
2193
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2194
|
+
|
2195
|
+
# form parameters
|
2196
|
+
form_params = opts[:form_params] || {}
|
2197
|
+
|
2198
|
+
# http body (model)
|
2199
|
+
post_body = opts[:debug_body]
|
2200
|
+
|
2201
|
+
# return_type
|
2202
|
+
return_type = opts[:debug_return_type] || 'WatchlistMonitor'
|
2203
|
+
|
2204
|
+
# auth_names
|
2205
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2206
|
+
|
2207
|
+
new_options = opts.merge(
|
2208
|
+
:operation => :"DefaultApi.find_watchlist_monitor",
|
2209
|
+
:header_params => header_params,
|
2210
|
+
:query_params => query_params,
|
2211
|
+
:form_params => form_params,
|
2212
|
+
:body => post_body,
|
2213
|
+
:auth_names => auth_names,
|
2214
|
+
:return_type => return_type
|
2215
|
+
)
|
2216
|
+
|
2217
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2218
|
+
if @api_client.config.debugging
|
2219
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_watchlist_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2220
|
+
end
|
2221
|
+
return data, status_code, headers
|
2222
|
+
end
|
2223
|
+
|
2224
|
+
# Retrieve a Webhook
|
2225
|
+
# Retrieves a single webhook. Returns a webhook object.
|
2226
|
+
# @param webhook_id [String]
|
2227
|
+
# @param [Hash] opts the optional parameters
|
2228
|
+
# @return [Webhook]
|
2229
|
+
def find_webhook(webhook_id, opts = {})
|
2230
|
+
data, _status_code, _headers = find_webhook_with_http_info(webhook_id, opts)
|
2231
|
+
data
|
2232
|
+
end
|
2233
|
+
|
2234
|
+
# Retrieve a Webhook
|
2235
|
+
# Retrieves a single webhook. Returns a webhook object.
|
2236
|
+
# @param webhook_id [String]
|
2237
|
+
# @param [Hash] opts the optional parameters
|
2238
|
+
# @return [Array<(Webhook, Integer, Hash)>] Webhook data, response status code and response headers
|
2239
|
+
def find_webhook_with_http_info(webhook_id, opts = {})
|
2240
|
+
if @api_client.config.debugging
|
2241
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_webhook ...'
|
2242
|
+
end
|
2243
|
+
# verify the required parameter 'webhook_id' is set
|
2244
|
+
if @api_client.config.client_side_validation && webhook_id.nil?
|
2245
|
+
fail ArgumentError, "Missing the required parameter 'webhook_id' when calling DefaultApi.find_webhook"
|
2246
|
+
end
|
2247
|
+
# resource path
|
2248
|
+
local_var_path = '/webhooks/{webhook_id}'.sub('{' + 'webhook_id' + '}', CGI.escape(webhook_id.to_s))
|
2249
|
+
|
2250
|
+
# query parameters
|
2251
|
+
query_params = opts[:query_params] || {}
|
2252
|
+
|
2253
|
+
# header parameters
|
2254
|
+
header_params = opts[:header_params] || {}
|
2255
|
+
# HTTP header 'Accept' (if needed)
|
2256
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2257
|
+
|
2258
|
+
# form parameters
|
2259
|
+
form_params = opts[:form_params] || {}
|
2260
|
+
|
2261
|
+
# http body (model)
|
2262
|
+
post_body = opts[:debug_body]
|
2263
|
+
|
2264
|
+
# return_type
|
2265
|
+
return_type = opts[:debug_return_type] || 'Webhook'
|
2266
|
+
|
2267
|
+
# auth_names
|
2268
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2269
|
+
|
2270
|
+
new_options = opts.merge(
|
2271
|
+
:operation => :"DefaultApi.find_webhook",
|
2272
|
+
:header_params => header_params,
|
2273
|
+
:query_params => query_params,
|
2274
|
+
:form_params => form_params,
|
2275
|
+
:body => post_body,
|
2276
|
+
:auth_names => auth_names,
|
2277
|
+
:return_type => return_type
|
2278
|
+
)
|
2279
|
+
|
2280
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2281
|
+
if @api_client.config.debugging
|
2282
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2283
|
+
end
|
2284
|
+
return data, status_code, headers
|
2285
|
+
end
|
2286
|
+
|
2287
|
+
# Retrieve Workflow Run
|
2288
|
+
# A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
2289
|
+
# @param workflow_run_id [String] The unique identifier of the Workflow Run.
|
2290
|
+
# @param [Hash] opts the optional parameters
|
2291
|
+
# @return [WorkflowRun]
|
2292
|
+
def find_workflow_run(workflow_run_id, opts = {})
|
2293
|
+
data, _status_code, _headers = find_workflow_run_with_http_info(workflow_run_id, opts)
|
2294
|
+
data
|
2295
|
+
end
|
2296
|
+
|
2297
|
+
# Retrieve Workflow Run
|
2298
|
+
# A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
2299
|
+
# @param workflow_run_id [String] The unique identifier of the Workflow Run.
|
2300
|
+
# @param [Hash] opts the optional parameters
|
2301
|
+
# @return [Array<(WorkflowRun, Integer, Hash)>] WorkflowRun data, response status code and response headers
|
2302
|
+
def find_workflow_run_with_http_info(workflow_run_id, opts = {})
|
2303
|
+
if @api_client.config.debugging
|
2304
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.find_workflow_run ...'
|
2305
|
+
end
|
2306
|
+
# verify the required parameter 'workflow_run_id' is set
|
2307
|
+
if @api_client.config.client_side_validation && workflow_run_id.nil?
|
2308
|
+
fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.find_workflow_run"
|
2309
|
+
end
|
2310
|
+
# resource path
|
2311
|
+
local_var_path = '/workflow_runs/{workflow_run_id}'.sub('{' + 'workflow_run_id' + '}', CGI.escape(workflow_run_id.to_s))
|
2312
|
+
|
2313
|
+
# query parameters
|
2314
|
+
query_params = opts[:query_params] || {}
|
2315
|
+
|
2316
|
+
# header parameters
|
2317
|
+
header_params = opts[:header_params] || {}
|
2318
|
+
# HTTP header 'Accept' (if needed)
|
2319
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2320
|
+
|
2321
|
+
# form parameters
|
2322
|
+
form_params = opts[:form_params] || {}
|
2323
|
+
|
2324
|
+
# http body (model)
|
2325
|
+
post_body = opts[:debug_body]
|
2326
|
+
|
2327
|
+
# return_type
|
2328
|
+
return_type = opts[:debug_return_type] || 'WorkflowRun'
|
2329
|
+
|
2330
|
+
# auth_names
|
2331
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2332
|
+
|
2333
|
+
new_options = opts.merge(
|
2334
|
+
:operation => :"DefaultApi.find_workflow_run",
|
2335
|
+
:header_params => header_params,
|
2336
|
+
:query_params => query_params,
|
2337
|
+
:form_params => form_params,
|
2338
|
+
:body => post_body,
|
2339
|
+
:auth_names => auth_names,
|
2340
|
+
:return_type => return_type
|
2341
|
+
)
|
2342
|
+
|
2343
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2344
|
+
if @api_client.config.debugging
|
2345
|
+
@api_client.config.logger.debug "API called: DefaultApi#find_workflow_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2346
|
+
end
|
2347
|
+
return data, status_code, headers
|
2348
|
+
end
|
2349
|
+
|
2350
|
+
# Force new report creation (BETA)
|
2351
|
+
# Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
|
2352
|
+
# @param monitor_id [String]
|
2353
|
+
# @param [Hash] opts the optional parameters
|
2354
|
+
# @return [nil]
|
2355
|
+
def force_report_creation_from_watchlist_monitor(monitor_id, opts = {})
|
2356
|
+
force_report_creation_from_watchlist_monitor_with_http_info(monitor_id, opts)
|
2357
|
+
nil
|
2358
|
+
end
|
2359
|
+
|
2360
|
+
# Force new report creation (BETA)
|
2361
|
+
# Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
|
2362
|
+
# @param monitor_id [String]
|
2363
|
+
# @param [Hash] opts the optional parameters
|
2364
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
2365
|
+
def force_report_creation_from_watchlist_monitor_with_http_info(monitor_id, opts = {})
|
2366
|
+
if @api_client.config.debugging
|
2367
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.force_report_creation_from_watchlist_monitor ...'
|
2368
|
+
end
|
2369
|
+
# verify the required parameter 'monitor_id' is set
|
2370
|
+
if @api_client.config.client_side_validation && monitor_id.nil?
|
2371
|
+
fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DefaultApi.force_report_creation_from_watchlist_monitor"
|
2372
|
+
end
|
2373
|
+
# resource path
|
2374
|
+
local_var_path = '/watchlist_monitors/{monitor_id}/new_report'.sub('{' + 'monitor_id' + '}', CGI.escape(monitor_id.to_s))
|
2375
|
+
|
2376
|
+
# query parameters
|
2377
|
+
query_params = opts[:query_params] || {}
|
2378
|
+
|
2379
|
+
# header parameters
|
2380
|
+
header_params = opts[:header_params] || {}
|
2381
|
+
# HTTP header 'Accept' (if needed)
|
2382
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2383
|
+
|
2384
|
+
# form parameters
|
2385
|
+
form_params = opts[:form_params] || {}
|
2386
|
+
|
2387
|
+
# http body (model)
|
2388
|
+
post_body = opts[:debug_body]
|
2389
|
+
|
2390
|
+
# return_type
|
2391
|
+
return_type = opts[:debug_return_type]
|
2392
|
+
|
2393
|
+
# auth_names
|
2394
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2395
|
+
|
2396
|
+
new_options = opts.merge(
|
2397
|
+
:operation => :"DefaultApi.force_report_creation_from_watchlist_monitor",
|
2398
|
+
:header_params => header_params,
|
2399
|
+
:query_params => query_params,
|
2400
|
+
:form_params => form_params,
|
2401
|
+
:body => post_body,
|
2402
|
+
:auth_names => auth_names,
|
2403
|
+
:return_type => return_type
|
2404
|
+
)
|
2405
|
+
|
2406
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2407
|
+
if @api_client.config.debugging
|
2408
|
+
@api_client.config.logger.debug "API called: DefaultApi#force_report_creation_from_watchlist_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2409
|
+
end
|
2410
|
+
return data, status_code, headers
|
2411
|
+
end
|
2412
|
+
|
2413
|
+
# Generate a SDK token
|
2414
|
+
# Generates an SDK token. Returns a token object containing the SDK token.
|
2415
|
+
# @param sdk_token_builder [SdkTokenBuilder]
|
2416
|
+
# @param [Hash] opts the optional parameters
|
2417
|
+
# @return [SdkToken]
|
2418
|
+
def generate_sdk_token(sdk_token_builder, opts = {})
|
2419
|
+
data, _status_code, _headers = generate_sdk_token_with_http_info(sdk_token_builder, opts)
|
2420
|
+
data
|
2421
|
+
end
|
2422
|
+
|
2423
|
+
# Generate a SDK token
|
2424
|
+
# Generates an SDK token. Returns a token object containing the SDK token.
|
2425
|
+
# @param sdk_token_builder [SdkTokenBuilder]
|
2426
|
+
# @param [Hash] opts the optional parameters
|
2427
|
+
# @return [Array<(SdkToken, Integer, Hash)>] SdkToken data, response status code and response headers
|
2428
|
+
def generate_sdk_token_with_http_info(sdk_token_builder, opts = {})
|
2429
|
+
if @api_client.config.debugging
|
2430
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.generate_sdk_token ...'
|
2431
|
+
end
|
2432
|
+
# verify the required parameter 'sdk_token_builder' is set
|
2433
|
+
if @api_client.config.client_side_validation && sdk_token_builder.nil?
|
2434
|
+
fail ArgumentError, "Missing the required parameter 'sdk_token_builder' when calling DefaultApi.generate_sdk_token"
|
2435
|
+
end
|
2436
|
+
# resource path
|
2437
|
+
local_var_path = '/sdk_token'
|
2438
|
+
|
2439
|
+
# query parameters
|
2440
|
+
query_params = opts[:query_params] || {}
|
2441
|
+
|
2442
|
+
# header parameters
|
2443
|
+
header_params = opts[:header_params] || {}
|
2444
|
+
# HTTP header 'Accept' (if needed)
|
2445
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2446
|
+
# HTTP header 'Content-Type'
|
2447
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
2448
|
+
if !content_type.nil?
|
2449
|
+
header_params['Content-Type'] = content_type
|
2450
|
+
end
|
2451
|
+
|
2452
|
+
# form parameters
|
2453
|
+
form_params = opts[:form_params] || {}
|
2454
|
+
|
2455
|
+
# http body (model)
|
2456
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sdk_token_builder)
|
2457
|
+
|
2458
|
+
# return_type
|
2459
|
+
return_type = opts[:debug_return_type] || 'SdkToken'
|
2460
|
+
|
2461
|
+
# auth_names
|
2462
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2463
|
+
|
2464
|
+
new_options = opts.merge(
|
2465
|
+
:operation => :"DefaultApi.generate_sdk_token",
|
2466
|
+
:header_params => header_params,
|
2467
|
+
:query_params => query_params,
|
2468
|
+
:form_params => form_params,
|
2469
|
+
:body => post_body,
|
2470
|
+
:auth_names => auth_names,
|
2471
|
+
:return_type => return_type
|
2472
|
+
)
|
2473
|
+
|
2474
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2475
|
+
if @api_client.config.debugging
|
2476
|
+
@api_client.config.logger.debug "API called: DefaultApi#generate_sdk_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2477
|
+
end
|
2478
|
+
return data, status_code, headers
|
2479
|
+
end
|
2480
|
+
|
2481
|
+
# List Applicants
|
2482
|
+
# Lists all applicants you've created, sorted by creation date in descending order.
|
2483
|
+
# @param [Hash] opts the optional parameters
|
2484
|
+
# @option opts [Integer] :page The page to return. The first page is `page=1` (default to 1)
|
2485
|
+
# @option opts [Integer] :per_page The number of objects per page. (default to 20)
|
2486
|
+
# @option opts [Boolean] :include_deleted Whether to also include applicants scheduled for deletion. (default to false)
|
2487
|
+
# @return [ApplicantsList]
|
2488
|
+
def list_applicants(opts = {})
|
2489
|
+
data, _status_code, _headers = list_applicants_with_http_info(opts)
|
2490
|
+
data
|
2491
|
+
end
|
2492
|
+
|
2493
|
+
# List Applicants
|
2494
|
+
# Lists all applicants you've created, sorted by creation date in descending order.
|
2495
|
+
# @param [Hash] opts the optional parameters
|
2496
|
+
# @option opts [Integer] :page The page to return. The first page is `page=1` (default to 1)
|
2497
|
+
# @option opts [Integer] :per_page The number of objects per page. (default to 20)
|
2498
|
+
# @option opts [Boolean] :include_deleted Whether to also include applicants scheduled for deletion. (default to false)
|
2499
|
+
# @return [Array<(ApplicantsList, Integer, Hash)>] ApplicantsList data, response status code and response headers
|
2500
|
+
def list_applicants_with_http_info(opts = {})
|
2501
|
+
if @api_client.config.debugging
|
2502
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_applicants ...'
|
2503
|
+
end
|
2504
|
+
# resource path
|
2505
|
+
local_var_path = '/applicants'
|
2506
|
+
|
2507
|
+
# query parameters
|
2508
|
+
query_params = opts[:query_params] || {}
|
2509
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
2510
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
2511
|
+
query_params[:'include_deleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
|
2512
|
+
|
2513
|
+
# header parameters
|
2514
|
+
header_params = opts[:header_params] || {}
|
2515
|
+
# HTTP header 'Accept' (if needed)
|
2516
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2517
|
+
|
2518
|
+
# form parameters
|
2519
|
+
form_params = opts[:form_params] || {}
|
2520
|
+
|
2521
|
+
# http body (model)
|
2522
|
+
post_body = opts[:debug_body]
|
2523
|
+
|
2524
|
+
# return_type
|
2525
|
+
return_type = opts[:debug_return_type] || 'ApplicantsList'
|
2526
|
+
|
2527
|
+
# auth_names
|
2528
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2529
|
+
|
2530
|
+
new_options = opts.merge(
|
2531
|
+
:operation => :"DefaultApi.list_applicants",
|
2532
|
+
:header_params => header_params,
|
2533
|
+
:query_params => query_params,
|
2534
|
+
:form_params => form_params,
|
2535
|
+
:body => post_body,
|
2536
|
+
:auth_names => auth_names,
|
2537
|
+
:return_type => return_type
|
2538
|
+
)
|
2539
|
+
|
2540
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2541
|
+
if @api_client.config.debugging
|
2542
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_applicants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2543
|
+
end
|
2544
|
+
return data, status_code, headers
|
2545
|
+
end
|
2546
|
+
|
2547
|
+
# Retrieve Checks
|
2548
|
+
# Retrieves a single check. Returns a check object.
|
2549
|
+
# @param applicant_id [String]
|
2550
|
+
# @param [Hash] opts the optional parameters
|
2551
|
+
# @return [ChecksList]
|
2552
|
+
def list_checks(applicant_id, opts = {})
|
2553
|
+
data, _status_code, _headers = list_checks_with_http_info(applicant_id, opts)
|
2554
|
+
data
|
2555
|
+
end
|
2556
|
+
|
2557
|
+
# Retrieve Checks
|
2558
|
+
# Retrieves a single check. Returns a check object.
|
2559
|
+
# @param applicant_id [String]
|
2560
|
+
# @param [Hash] opts the optional parameters
|
2561
|
+
# @return [Array<(ChecksList, Integer, Hash)>] ChecksList data, response status code and response headers
|
2562
|
+
def list_checks_with_http_info(applicant_id, opts = {})
|
2563
|
+
if @api_client.config.debugging
|
2564
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_checks ...'
|
2565
|
+
end
|
2566
|
+
# verify the required parameter 'applicant_id' is set
|
2567
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
2568
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.list_checks"
|
2569
|
+
end
|
2570
|
+
# resource path
|
2571
|
+
local_var_path = '/checks'
|
2572
|
+
|
2573
|
+
# query parameters
|
2574
|
+
query_params = opts[:query_params] || {}
|
2575
|
+
query_params[:'applicant_id'] = applicant_id
|
2576
|
+
|
2577
|
+
# header parameters
|
2578
|
+
header_params = opts[:header_params] || {}
|
2579
|
+
# HTTP header 'Accept' (if needed)
|
2580
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2581
|
+
|
2582
|
+
# form parameters
|
2583
|
+
form_params = opts[:form_params] || {}
|
2584
|
+
|
2585
|
+
# http body (model)
|
2586
|
+
post_body = opts[:debug_body]
|
2587
|
+
|
2588
|
+
# return_type
|
2589
|
+
return_type = opts[:debug_return_type] || 'ChecksList'
|
2590
|
+
|
2591
|
+
# auth_names
|
2592
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2593
|
+
|
2594
|
+
new_options = opts.merge(
|
2595
|
+
:operation => :"DefaultApi.list_checks",
|
2596
|
+
:header_params => header_params,
|
2597
|
+
:query_params => query_params,
|
2598
|
+
:form_params => form_params,
|
2599
|
+
:body => post_body,
|
2600
|
+
:auth_names => auth_names,
|
2601
|
+
:return_type => return_type
|
2602
|
+
)
|
2603
|
+
|
2604
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2605
|
+
if @api_client.config.debugging
|
2606
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_checks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2607
|
+
end
|
2608
|
+
return data, status_code, headers
|
2609
|
+
end
|
2610
|
+
|
2611
|
+
# List documents
|
2612
|
+
# All documents belonging to an applicant can be listed from this endpoint
|
2613
|
+
# @param applicant_id [String]
|
2614
|
+
# @param [Hash] opts the optional parameters
|
2615
|
+
# @return [DocumentsList]
|
2616
|
+
def list_documents(applicant_id, opts = {})
|
2617
|
+
data, _status_code, _headers = list_documents_with_http_info(applicant_id, opts)
|
2618
|
+
data
|
2619
|
+
end
|
2620
|
+
|
2621
|
+
# List documents
|
2622
|
+
# All documents belonging to an applicant can be listed from this endpoint
|
2623
|
+
# @param applicant_id [String]
|
2624
|
+
# @param [Hash] opts the optional parameters
|
2625
|
+
# @return [Array<(DocumentsList, Integer, Hash)>] DocumentsList data, response status code and response headers
|
2626
|
+
def list_documents_with_http_info(applicant_id, opts = {})
|
2627
|
+
if @api_client.config.debugging
|
2628
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_documents ...'
|
2629
|
+
end
|
2630
|
+
# verify the required parameter 'applicant_id' is set
|
2631
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
2632
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.list_documents"
|
2633
|
+
end
|
2634
|
+
# resource path
|
2635
|
+
local_var_path = '/documents'
|
2636
|
+
|
2637
|
+
# query parameters
|
2638
|
+
query_params = opts[:query_params] || {}
|
2639
|
+
query_params[:'applicant_id'] = applicant_id
|
2640
|
+
|
2641
|
+
# header parameters
|
2642
|
+
header_params = opts[:header_params] || {}
|
2643
|
+
# HTTP header 'Accept' (if needed)
|
2644
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2645
|
+
|
2646
|
+
# form parameters
|
2647
|
+
form_params = opts[:form_params] || {}
|
2648
|
+
|
2649
|
+
# http body (model)
|
2650
|
+
post_body = opts[:debug_body]
|
2651
|
+
|
2652
|
+
# return_type
|
2653
|
+
return_type = opts[:debug_return_type] || 'DocumentsList'
|
2654
|
+
|
2655
|
+
# auth_names
|
2656
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2657
|
+
|
2658
|
+
new_options = opts.merge(
|
2659
|
+
:operation => :"DefaultApi.list_documents",
|
2660
|
+
:header_params => header_params,
|
2661
|
+
:query_params => query_params,
|
2662
|
+
:form_params => form_params,
|
2663
|
+
:body => post_body,
|
2664
|
+
:auth_names => auth_names,
|
2665
|
+
:return_type => return_type
|
2666
|
+
)
|
2667
|
+
|
2668
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2669
|
+
if @api_client.config.debugging
|
2670
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2671
|
+
end
|
2672
|
+
return data, status_code, headers
|
2673
|
+
end
|
2674
|
+
|
2675
|
+
# List ID photos
|
2676
|
+
# Lists the ID photos that belong to an applicant.
|
2677
|
+
# @param applicant_id [String] The id of the applicant the ID photos belong to.
|
2678
|
+
# @param [Hash] opts the optional parameters
|
2679
|
+
# @return [IdPhotosList]
|
2680
|
+
def list_id_photos(applicant_id, opts = {})
|
2681
|
+
data, _status_code, _headers = list_id_photos_with_http_info(applicant_id, opts)
|
2682
|
+
data
|
2683
|
+
end
|
2684
|
+
|
2685
|
+
# List ID photos
|
2686
|
+
# Lists the ID photos that belong to an applicant.
|
2687
|
+
# @param applicant_id [String] The id of the applicant the ID photos belong to.
|
2688
|
+
# @param [Hash] opts the optional parameters
|
2689
|
+
# @return [Array<(IdPhotosList, Integer, Hash)>] IdPhotosList data, response status code and response headers
|
2690
|
+
def list_id_photos_with_http_info(applicant_id, opts = {})
|
2691
|
+
if @api_client.config.debugging
|
2692
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_id_photos ...'
|
2693
|
+
end
|
2694
|
+
# verify the required parameter 'applicant_id' is set
|
2695
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
2696
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.list_id_photos"
|
2697
|
+
end
|
2698
|
+
# resource path
|
2699
|
+
local_var_path = '/id_photos'
|
2700
|
+
|
2701
|
+
# query parameters
|
2702
|
+
query_params = opts[:query_params] || {}
|
2703
|
+
query_params[:'applicant_id'] = applicant_id
|
2704
|
+
|
2705
|
+
# header parameters
|
2706
|
+
header_params = opts[:header_params] || {}
|
2707
|
+
# HTTP header 'Accept' (if needed)
|
2708
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2709
|
+
|
2710
|
+
# form parameters
|
2711
|
+
form_params = opts[:form_params] || {}
|
2712
|
+
|
2713
|
+
# http body (model)
|
2714
|
+
post_body = opts[:debug_body]
|
2715
|
+
|
2716
|
+
# return_type
|
2717
|
+
return_type = opts[:debug_return_type] || 'IdPhotosList'
|
2718
|
+
|
2719
|
+
# auth_names
|
2720
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2721
|
+
|
2722
|
+
new_options = opts.merge(
|
2723
|
+
:operation => :"DefaultApi.list_id_photos",
|
2724
|
+
:header_params => header_params,
|
2725
|
+
:query_params => query_params,
|
2726
|
+
:form_params => form_params,
|
2727
|
+
:body => post_body,
|
2728
|
+
:auth_names => auth_names,
|
2729
|
+
:return_type => return_type
|
2730
|
+
)
|
2731
|
+
|
2732
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2733
|
+
if @api_client.config.debugging
|
2734
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_id_photos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2735
|
+
end
|
2736
|
+
return data, status_code, headers
|
2737
|
+
end
|
2738
|
+
|
2739
|
+
# List live photos
|
2740
|
+
# Lists the live photos that belong to an applicant.
|
2741
|
+
# @param applicant_id [String] The id of the applicant the live photos belong to.
|
2742
|
+
# @param [Hash] opts the optional parameters
|
2743
|
+
# @return [LivePhotosList]
|
2744
|
+
def list_live_photos(applicant_id, opts = {})
|
2745
|
+
data, _status_code, _headers = list_live_photos_with_http_info(applicant_id, opts)
|
2746
|
+
data
|
2747
|
+
end
|
2748
|
+
|
2749
|
+
# List live photos
|
2750
|
+
# Lists the live photos that belong to an applicant.
|
2751
|
+
# @param applicant_id [String] The id of the applicant the live photos belong to.
|
2752
|
+
# @param [Hash] opts the optional parameters
|
2753
|
+
# @return [Array<(LivePhotosList, Integer, Hash)>] LivePhotosList data, response status code and response headers
|
2754
|
+
def list_live_photos_with_http_info(applicant_id, opts = {})
|
2755
|
+
if @api_client.config.debugging
|
2756
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_live_photos ...'
|
2757
|
+
end
|
2758
|
+
# verify the required parameter 'applicant_id' is set
|
2759
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
2760
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.list_live_photos"
|
2761
|
+
end
|
2762
|
+
# resource path
|
2763
|
+
local_var_path = '/live_photos'
|
2764
|
+
|
2765
|
+
# query parameters
|
2766
|
+
query_params = opts[:query_params] || {}
|
2767
|
+
query_params[:'applicant_id'] = applicant_id
|
2768
|
+
|
2769
|
+
# header parameters
|
2770
|
+
header_params = opts[:header_params] || {}
|
2771
|
+
# HTTP header 'Accept' (if needed)
|
2772
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2773
|
+
|
2774
|
+
# form parameters
|
2775
|
+
form_params = opts[:form_params] || {}
|
2776
|
+
|
2777
|
+
# http body (model)
|
2778
|
+
post_body = opts[:debug_body]
|
2779
|
+
|
2780
|
+
# return_type
|
2781
|
+
return_type = opts[:debug_return_type] || 'LivePhotosList'
|
2782
|
+
|
2783
|
+
# auth_names
|
2784
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2785
|
+
|
2786
|
+
new_options = opts.merge(
|
2787
|
+
:operation => :"DefaultApi.list_live_photos",
|
2788
|
+
:header_params => header_params,
|
2789
|
+
:query_params => query_params,
|
2790
|
+
:form_params => form_params,
|
2791
|
+
:body => post_body,
|
2792
|
+
:auth_names => auth_names,
|
2793
|
+
:return_type => return_type
|
2794
|
+
)
|
2795
|
+
|
2796
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2797
|
+
if @api_client.config.debugging
|
2798
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_live_photos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2799
|
+
end
|
2800
|
+
return data, status_code, headers
|
2801
|
+
end
|
2802
|
+
|
2803
|
+
# List live videos
|
2804
|
+
# Lists all the live videos that belong to an applicant.
|
2805
|
+
# @param applicant_id [String] The id of the applicant the live videos belong to.
|
2806
|
+
# @param [Hash] opts the optional parameters
|
2807
|
+
# @return [LiveVideosList]
|
2808
|
+
def list_live_videos(applicant_id, opts = {})
|
2809
|
+
data, _status_code, _headers = list_live_videos_with_http_info(applicant_id, opts)
|
2810
|
+
data
|
2811
|
+
end
|
2812
|
+
|
2813
|
+
# List live videos
|
2814
|
+
# Lists all the live videos that belong to an applicant.
|
2815
|
+
# @param applicant_id [String] The id of the applicant the live videos belong to.
|
2816
|
+
# @param [Hash] opts the optional parameters
|
2817
|
+
# @return [Array<(LiveVideosList, Integer, Hash)>] LiveVideosList data, response status code and response headers
|
2818
|
+
def list_live_videos_with_http_info(applicant_id, opts = {})
|
2819
|
+
if @api_client.config.debugging
|
2820
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_live_videos ...'
|
2821
|
+
end
|
2822
|
+
# verify the required parameter 'applicant_id' is set
|
2823
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
2824
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.list_live_videos"
|
2825
|
+
end
|
2826
|
+
# resource path
|
2827
|
+
local_var_path = '/live_videos'
|
2828
|
+
|
2829
|
+
# query parameters
|
2830
|
+
query_params = opts[:query_params] || {}
|
2831
|
+
query_params[:'applicant_id'] = applicant_id
|
2832
|
+
|
2833
|
+
# header parameters
|
2834
|
+
header_params = opts[:header_params] || {}
|
2835
|
+
# HTTP header 'Accept' (if needed)
|
2836
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2837
|
+
|
2838
|
+
# form parameters
|
2839
|
+
form_params = opts[:form_params] || {}
|
2840
|
+
|
2841
|
+
# http body (model)
|
2842
|
+
post_body = opts[:debug_body]
|
2843
|
+
|
2844
|
+
# return_type
|
2845
|
+
return_type = opts[:debug_return_type] || 'LiveVideosList'
|
2846
|
+
|
2847
|
+
# auth_names
|
2848
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2849
|
+
|
2850
|
+
new_options = opts.merge(
|
2851
|
+
:operation => :"DefaultApi.list_live_videos",
|
2852
|
+
:header_params => header_params,
|
2853
|
+
:query_params => query_params,
|
2854
|
+
:form_params => form_params,
|
2855
|
+
:body => post_body,
|
2856
|
+
:auth_names => auth_names,
|
2857
|
+
:return_type => return_type
|
2858
|
+
)
|
2859
|
+
|
2860
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2861
|
+
if @api_client.config.debugging
|
2862
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_live_videos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2863
|
+
end
|
2864
|
+
return data, status_code, headers
|
2865
|
+
end
|
2866
|
+
|
2867
|
+
# List motion captures
|
2868
|
+
# Lists all the motion captures that belong to an applicant.
|
2869
|
+
# @param applicant_id [String] The id of the applicant the motion captures belong to.
|
2870
|
+
# @param [Hash] opts the optional parameters
|
2871
|
+
# @return [MotionCapturesList]
|
2872
|
+
def list_motion_captures(applicant_id, opts = {})
|
2873
|
+
data, _status_code, _headers = list_motion_captures_with_http_info(applicant_id, opts)
|
2874
|
+
data
|
2875
|
+
end
|
2876
|
+
|
2877
|
+
# List motion captures
|
2878
|
+
# Lists all the motion captures that belong to an applicant.
|
2879
|
+
# @param applicant_id [String] The id of the applicant the motion captures belong to.
|
2880
|
+
# @param [Hash] opts the optional parameters
|
2881
|
+
# @return [Array<(MotionCapturesList, Integer, Hash)>] MotionCapturesList data, response status code and response headers
|
2882
|
+
def list_motion_captures_with_http_info(applicant_id, opts = {})
|
2883
|
+
if @api_client.config.debugging
|
2884
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_motion_captures ...'
|
2885
|
+
end
|
2886
|
+
# verify the required parameter 'applicant_id' is set
|
2887
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
2888
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.list_motion_captures"
|
2889
|
+
end
|
2890
|
+
# resource path
|
2891
|
+
local_var_path = '/motion_captures'
|
2892
|
+
|
2893
|
+
# query parameters
|
2894
|
+
query_params = opts[:query_params] || {}
|
2895
|
+
query_params[:'applicant_id'] = applicant_id
|
2896
|
+
|
2897
|
+
# header parameters
|
2898
|
+
header_params = opts[:header_params] || {}
|
2899
|
+
# HTTP header 'Accept' (if needed)
|
2900
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2901
|
+
|
2902
|
+
# form parameters
|
2903
|
+
form_params = opts[:form_params] || {}
|
2904
|
+
|
2905
|
+
# http body (model)
|
2906
|
+
post_body = opts[:debug_body]
|
2907
|
+
|
2908
|
+
# return_type
|
2909
|
+
return_type = opts[:debug_return_type] || 'MotionCapturesList'
|
2910
|
+
|
2911
|
+
# auth_names
|
2912
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2913
|
+
|
2914
|
+
new_options = opts.merge(
|
2915
|
+
:operation => :"DefaultApi.list_motion_captures",
|
2916
|
+
:header_params => header_params,
|
2917
|
+
:query_params => query_params,
|
2918
|
+
:form_params => form_params,
|
2919
|
+
:body => post_body,
|
2920
|
+
:auth_names => auth_names,
|
2921
|
+
:return_type => return_type
|
2922
|
+
)
|
2923
|
+
|
2924
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2925
|
+
if @api_client.config.debugging
|
2926
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_motion_captures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2927
|
+
end
|
2928
|
+
return data, status_code, headers
|
2929
|
+
end
|
2930
|
+
|
2931
|
+
# Retrieve repeat attempts
|
2932
|
+
# Returns all repeat attempts for a given Document report
|
2933
|
+
# @param report_id [String]
|
2934
|
+
# @param [Hash] opts the optional parameters
|
2935
|
+
# @return [RepeatAttemptsList]
|
2936
|
+
def list_repeat_attempts(report_id, opts = {})
|
2937
|
+
data, _status_code, _headers = list_repeat_attempts_with_http_info(report_id, opts)
|
2938
|
+
data
|
2939
|
+
end
|
2940
|
+
|
2941
|
+
# Retrieve repeat attempts
|
2942
|
+
# Returns all repeat attempts for a given Document report
|
2943
|
+
# @param report_id [String]
|
2944
|
+
# @param [Hash] opts the optional parameters
|
2945
|
+
# @return [Array<(RepeatAttemptsList, Integer, Hash)>] RepeatAttemptsList data, response status code and response headers
|
2946
|
+
def list_repeat_attempts_with_http_info(report_id, opts = {})
|
2947
|
+
if @api_client.config.debugging
|
2948
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_repeat_attempts ...'
|
2949
|
+
end
|
2950
|
+
# verify the required parameter 'report_id' is set
|
2951
|
+
if @api_client.config.client_side_validation && report_id.nil?
|
2952
|
+
fail ArgumentError, "Missing the required parameter 'report_id' when calling DefaultApi.list_repeat_attempts"
|
2953
|
+
end
|
2954
|
+
# resource path
|
2955
|
+
local_var_path = '/repeat_attempts/{report_id}'.sub('{' + 'report_id' + '}', CGI.escape(report_id.to_s))
|
2956
|
+
|
2957
|
+
# query parameters
|
2958
|
+
query_params = opts[:query_params] || {}
|
2959
|
+
|
2960
|
+
# header parameters
|
2961
|
+
header_params = opts[:header_params] || {}
|
2962
|
+
# HTTP header 'Accept' (if needed)
|
2963
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2964
|
+
|
2965
|
+
# form parameters
|
2966
|
+
form_params = opts[:form_params] || {}
|
2967
|
+
|
2968
|
+
# http body (model)
|
2969
|
+
post_body = opts[:debug_body]
|
2970
|
+
|
2971
|
+
# return_type
|
2972
|
+
return_type = opts[:debug_return_type] || 'RepeatAttemptsList'
|
2973
|
+
|
2974
|
+
# auth_names
|
2975
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
2976
|
+
|
2977
|
+
new_options = opts.merge(
|
2978
|
+
:operation => :"DefaultApi.list_repeat_attempts",
|
2979
|
+
:header_params => header_params,
|
2980
|
+
:query_params => query_params,
|
2981
|
+
:form_params => form_params,
|
2982
|
+
:body => post_body,
|
2983
|
+
:auth_names => auth_names,
|
2984
|
+
:return_type => return_type
|
2985
|
+
)
|
2986
|
+
|
2987
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2988
|
+
if @api_client.config.debugging
|
2989
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_repeat_attempts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2990
|
+
end
|
2991
|
+
return data, status_code, headers
|
2992
|
+
end
|
2993
|
+
|
2994
|
+
# List reports
|
2995
|
+
# All the reports belonging to a particular check can be listed from this endpoint.
|
2996
|
+
# @param check_id [String]
|
2997
|
+
# @param [Hash] opts the optional parameters
|
2998
|
+
# @return [ReportsList]
|
2999
|
+
def list_reports(check_id, opts = {})
|
3000
|
+
data, _status_code, _headers = list_reports_with_http_info(check_id, opts)
|
3001
|
+
data
|
3002
|
+
end
|
3003
|
+
|
3004
|
+
# List reports
|
3005
|
+
# All the reports belonging to a particular check can be listed from this endpoint.
|
3006
|
+
# @param check_id [String]
|
3007
|
+
# @param [Hash] opts the optional parameters
|
3008
|
+
# @return [Array<(ReportsList, Integer, Hash)>] ReportsList data, response status code and response headers
|
3009
|
+
def list_reports_with_http_info(check_id, opts = {})
|
3010
|
+
if @api_client.config.debugging
|
3011
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_reports ...'
|
3012
|
+
end
|
3013
|
+
# verify the required parameter 'check_id' is set
|
3014
|
+
if @api_client.config.client_side_validation && check_id.nil?
|
3015
|
+
fail ArgumentError, "Missing the required parameter 'check_id' when calling DefaultApi.list_reports"
|
3016
|
+
end
|
3017
|
+
# resource path
|
3018
|
+
local_var_path = '/reports'
|
3019
|
+
|
3020
|
+
# query parameters
|
3021
|
+
query_params = opts[:query_params] || {}
|
3022
|
+
query_params[:'check_id'] = check_id
|
3023
|
+
|
3024
|
+
# header parameters
|
3025
|
+
header_params = opts[:header_params] || {}
|
3026
|
+
# HTTP header 'Accept' (if needed)
|
3027
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3028
|
+
|
3029
|
+
# form parameters
|
3030
|
+
form_params = opts[:form_params] || {}
|
3031
|
+
|
3032
|
+
# http body (model)
|
3033
|
+
post_body = opts[:debug_body]
|
3034
|
+
|
3035
|
+
# return_type
|
3036
|
+
return_type = opts[:debug_return_type] || 'ReportsList'
|
3037
|
+
|
3038
|
+
# auth_names
|
3039
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3040
|
+
|
3041
|
+
new_options = opts.merge(
|
3042
|
+
:operation => :"DefaultApi.list_reports",
|
3043
|
+
:header_params => header_params,
|
3044
|
+
:query_params => query_params,
|
3045
|
+
:form_params => form_params,
|
3046
|
+
:body => post_body,
|
3047
|
+
:auth_names => auth_names,
|
3048
|
+
:return_type => return_type
|
3049
|
+
)
|
3050
|
+
|
3051
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3052
|
+
if @api_client.config.debugging
|
3053
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_reports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3054
|
+
end
|
3055
|
+
return data, status_code, headers
|
3056
|
+
end
|
3057
|
+
|
3058
|
+
# List Tasks
|
3059
|
+
# The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
3060
|
+
# @param workflow_run_id [String] The unique identifier of the Workflow Run to which the Tasks belong.
|
3061
|
+
# @param [Hash] opts the optional parameters
|
3062
|
+
# @return [Array<TaskItem>]
|
3063
|
+
def list_tasks(workflow_run_id, opts = {})
|
3064
|
+
data, _status_code, _headers = list_tasks_with_http_info(workflow_run_id, opts)
|
3065
|
+
data
|
3066
|
+
end
|
3067
|
+
|
3068
|
+
# List Tasks
|
3069
|
+
# The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
|
3070
|
+
# @param workflow_run_id [String] The unique identifier of the Workflow Run to which the Tasks belong.
|
3071
|
+
# @param [Hash] opts the optional parameters
|
3072
|
+
# @return [Array<(Array<TaskItem>, Integer, Hash)>] Array<TaskItem> data, response status code and response headers
|
3073
|
+
def list_tasks_with_http_info(workflow_run_id, opts = {})
|
3074
|
+
if @api_client.config.debugging
|
3075
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_tasks ...'
|
3076
|
+
end
|
3077
|
+
# verify the required parameter 'workflow_run_id' is set
|
3078
|
+
if @api_client.config.client_side_validation && workflow_run_id.nil?
|
3079
|
+
fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.list_tasks"
|
3080
|
+
end
|
3081
|
+
# resource path
|
3082
|
+
local_var_path = '/workflow_runs/{workflow_run_id}/tasks'.sub('{' + 'workflow_run_id' + '}', CGI.escape(workflow_run_id.to_s))
|
3083
|
+
|
3084
|
+
# query parameters
|
3085
|
+
query_params = opts[:query_params] || {}
|
3086
|
+
|
3087
|
+
# header parameters
|
3088
|
+
header_params = opts[:header_params] || {}
|
3089
|
+
# HTTP header 'Accept' (if needed)
|
3090
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3091
|
+
|
3092
|
+
# form parameters
|
3093
|
+
form_params = opts[:form_params] || {}
|
3094
|
+
|
3095
|
+
# http body (model)
|
3096
|
+
post_body = opts[:debug_body]
|
3097
|
+
|
3098
|
+
# return_type
|
3099
|
+
return_type = opts[:debug_return_type] || 'Array<TaskItem>'
|
3100
|
+
|
3101
|
+
# auth_names
|
3102
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3103
|
+
|
3104
|
+
new_options = opts.merge(
|
3105
|
+
:operation => :"DefaultApi.list_tasks",
|
3106
|
+
:header_params => header_params,
|
3107
|
+
:query_params => query_params,
|
3108
|
+
:form_params => form_params,
|
3109
|
+
:body => post_body,
|
3110
|
+
:auth_names => auth_names,
|
3111
|
+
:return_type => return_type
|
3112
|
+
)
|
3113
|
+
|
3114
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3115
|
+
if @api_client.config.debugging
|
3116
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3117
|
+
end
|
3118
|
+
return data, status_code, headers
|
3119
|
+
end
|
3120
|
+
|
3121
|
+
# List matches (BETA)
|
3122
|
+
# List match IDs on this monitor, as well as their enabled/disabled status
|
3123
|
+
# @param monitor_id [String]
|
3124
|
+
# @param [Hash] opts the optional parameters
|
3125
|
+
# @return [WatchlistMonitorMatchesList]
|
3126
|
+
def list_watchlist_monitor_matches(monitor_id, opts = {})
|
3127
|
+
data, _status_code, _headers = list_watchlist_monitor_matches_with_http_info(monitor_id, opts)
|
3128
|
+
data
|
3129
|
+
end
|
3130
|
+
|
3131
|
+
# List matches (BETA)
|
3132
|
+
# List match IDs on this monitor, as well as their enabled/disabled status
|
3133
|
+
# @param monitor_id [String]
|
3134
|
+
# @param [Hash] opts the optional parameters
|
3135
|
+
# @return [Array<(WatchlistMonitorMatchesList, Integer, Hash)>] WatchlistMonitorMatchesList data, response status code and response headers
|
3136
|
+
def list_watchlist_monitor_matches_with_http_info(monitor_id, opts = {})
|
3137
|
+
if @api_client.config.debugging
|
3138
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_watchlist_monitor_matches ...'
|
3139
|
+
end
|
3140
|
+
# verify the required parameter 'monitor_id' is set
|
3141
|
+
if @api_client.config.client_side_validation && monitor_id.nil?
|
3142
|
+
fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DefaultApi.list_watchlist_monitor_matches"
|
3143
|
+
end
|
3144
|
+
# resource path
|
3145
|
+
local_var_path = '/watchlist_monitors/{monitor_id}/matches'.sub('{' + 'monitor_id' + '}', CGI.escape(monitor_id.to_s))
|
3146
|
+
|
3147
|
+
# query parameters
|
3148
|
+
query_params = opts[:query_params] || {}
|
3149
|
+
|
3150
|
+
# header parameters
|
3151
|
+
header_params = opts[:header_params] || {}
|
3152
|
+
# HTTP header 'Accept' (if needed)
|
3153
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3154
|
+
|
3155
|
+
# form parameters
|
3156
|
+
form_params = opts[:form_params] || {}
|
3157
|
+
|
3158
|
+
# http body (model)
|
3159
|
+
post_body = opts[:debug_body]
|
3160
|
+
|
3161
|
+
# return_type
|
3162
|
+
return_type = opts[:debug_return_type] || 'WatchlistMonitorMatchesList'
|
3163
|
+
|
3164
|
+
# auth_names
|
3165
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3166
|
+
|
3167
|
+
new_options = opts.merge(
|
3168
|
+
:operation => :"DefaultApi.list_watchlist_monitor_matches",
|
3169
|
+
:header_params => header_params,
|
3170
|
+
:query_params => query_params,
|
3171
|
+
:form_params => form_params,
|
3172
|
+
:body => post_body,
|
3173
|
+
:auth_names => auth_names,
|
3174
|
+
:return_type => return_type
|
3175
|
+
)
|
3176
|
+
|
3177
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3178
|
+
if @api_client.config.debugging
|
3179
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_watchlist_monitor_matches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3180
|
+
end
|
3181
|
+
return data, status_code, headers
|
3182
|
+
end
|
3183
|
+
|
3184
|
+
# List monitors
|
3185
|
+
# List all available monitors for an applicant
|
3186
|
+
# @param applicant_id [String] The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.
|
3187
|
+
# @param [Hash] opts the optional parameters
|
3188
|
+
# @option opts [Boolean] :include_deleted Whether to also include deleted (inactive) monitors. (default to false)
|
3189
|
+
# @return [WatchlistMonitorsList]
|
3190
|
+
def list_watchlist_monitors(applicant_id, opts = {})
|
3191
|
+
data, _status_code, _headers = list_watchlist_monitors_with_http_info(applicant_id, opts)
|
3192
|
+
data
|
3193
|
+
end
|
3194
|
+
|
3195
|
+
# List monitors
|
3196
|
+
# List all available monitors for an applicant
|
3197
|
+
# @param applicant_id [String] The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.
|
3198
|
+
# @param [Hash] opts the optional parameters
|
3199
|
+
# @option opts [Boolean] :include_deleted Whether to also include deleted (inactive) monitors. (default to false)
|
3200
|
+
# @return [Array<(WatchlistMonitorsList, Integer, Hash)>] WatchlistMonitorsList data, response status code and response headers
|
3201
|
+
def list_watchlist_monitors_with_http_info(applicant_id, opts = {})
|
3202
|
+
if @api_client.config.debugging
|
3203
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_watchlist_monitors ...'
|
3204
|
+
end
|
3205
|
+
# verify the required parameter 'applicant_id' is set
|
3206
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
3207
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.list_watchlist_monitors"
|
3208
|
+
end
|
3209
|
+
# resource path
|
3210
|
+
local_var_path = '/watchlist_monitors'
|
3211
|
+
|
3212
|
+
# query parameters
|
3213
|
+
query_params = opts[:query_params] || {}
|
3214
|
+
query_params[:'applicant_id'] = applicant_id
|
3215
|
+
query_params[:'include_deleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
|
3216
|
+
|
3217
|
+
# header parameters
|
3218
|
+
header_params = opts[:header_params] || {}
|
3219
|
+
# HTTP header 'Accept' (if needed)
|
3220
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3221
|
+
|
3222
|
+
# form parameters
|
3223
|
+
form_params = opts[:form_params] || {}
|
3224
|
+
|
3225
|
+
# http body (model)
|
3226
|
+
post_body = opts[:debug_body]
|
3227
|
+
|
3228
|
+
# return_type
|
3229
|
+
return_type = opts[:debug_return_type] || 'WatchlistMonitorsList'
|
3230
|
+
|
3231
|
+
# auth_names
|
3232
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3233
|
+
|
3234
|
+
new_options = opts.merge(
|
3235
|
+
:operation => :"DefaultApi.list_watchlist_monitors",
|
3236
|
+
:header_params => header_params,
|
3237
|
+
:query_params => query_params,
|
3238
|
+
:form_params => form_params,
|
3239
|
+
:body => post_body,
|
3240
|
+
:auth_names => auth_names,
|
3241
|
+
:return_type => return_type
|
3242
|
+
)
|
3243
|
+
|
3244
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3245
|
+
if @api_client.config.debugging
|
3246
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_watchlist_monitors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3247
|
+
end
|
3248
|
+
return data, status_code, headers
|
3249
|
+
end
|
3250
|
+
|
3251
|
+
# List webhooks
|
3252
|
+
# Lists all webhooks you've created.
|
3253
|
+
# @param [Hash] opts the optional parameters
|
3254
|
+
# @return [WebhooksList]
|
3255
|
+
def list_webhooks(opts = {})
|
3256
|
+
data, _status_code, _headers = list_webhooks_with_http_info(opts)
|
3257
|
+
data
|
3258
|
+
end
|
3259
|
+
|
3260
|
+
# List webhooks
|
3261
|
+
# Lists all webhooks you've created.
|
3262
|
+
# @param [Hash] opts the optional parameters
|
3263
|
+
# @return [Array<(WebhooksList, Integer, Hash)>] WebhooksList data, response status code and response headers
|
3264
|
+
def list_webhooks_with_http_info(opts = {})
|
3265
|
+
if @api_client.config.debugging
|
3266
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_webhooks ...'
|
3267
|
+
end
|
3268
|
+
# resource path
|
3269
|
+
local_var_path = '/webhooks'
|
3270
|
+
|
3271
|
+
# query parameters
|
3272
|
+
query_params = opts[:query_params] || {}
|
3273
|
+
|
3274
|
+
# header parameters
|
3275
|
+
header_params = opts[:header_params] || {}
|
3276
|
+
# HTTP header 'Accept' (if needed)
|
3277
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3278
|
+
|
3279
|
+
# form parameters
|
3280
|
+
form_params = opts[:form_params] || {}
|
3281
|
+
|
3282
|
+
# http body (model)
|
3283
|
+
post_body = opts[:debug_body]
|
3284
|
+
|
3285
|
+
# return_type
|
3286
|
+
return_type = opts[:debug_return_type] || 'WebhooksList'
|
3287
|
+
|
3288
|
+
# auth_names
|
3289
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3290
|
+
|
3291
|
+
new_options = opts.merge(
|
3292
|
+
:operation => :"DefaultApi.list_webhooks",
|
3293
|
+
:header_params => header_params,
|
3294
|
+
:query_params => query_params,
|
3295
|
+
:form_params => form_params,
|
3296
|
+
:body => post_body,
|
3297
|
+
:auth_names => auth_names,
|
3298
|
+
:return_type => return_type
|
3299
|
+
)
|
3300
|
+
|
3301
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3302
|
+
if @api_client.config.debugging
|
3303
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3304
|
+
end
|
3305
|
+
return data, status_code, headers
|
3306
|
+
end
|
3307
|
+
|
3308
|
+
# List Workflow Runs
|
3309
|
+
# Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.
|
3310
|
+
# @param [Hash] opts the optional parameters
|
3311
|
+
# @option opts [Integer] :page The number of the page to be retrieved. If not specified, defaults to 1. (default to 1)
|
3312
|
+
# @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'.
|
3313
|
+
# @option opts [Time] :created_at_gt A ISO-8601 date to filter results with a created date greater than (after) the one provided.
|
3314
|
+
# @option opts [Time] :created_at_lt A ISO-8601 date to filter results with a created date less than (before) the one provided.
|
3315
|
+
# @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')
|
3316
|
+
# @return [Array<WorkflowRun>]
|
3317
|
+
def list_workflow_runs(opts = {})
|
3318
|
+
data, _status_code, _headers = list_workflow_runs_with_http_info(opts)
|
3319
|
+
data
|
3320
|
+
end
|
3321
|
+
|
3322
|
+
# List Workflow Runs
|
3323
|
+
# Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.
|
3324
|
+
# @param [Hash] opts the optional parameters
|
3325
|
+
# @option opts [Integer] :page The number of the page to be retrieved. If not specified, defaults to 1. (default to 1)
|
3326
|
+
# @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'.
|
3327
|
+
# @option opts [Time] :created_at_gt A ISO-8601 date to filter results with a created date greater than (after) the one provided.
|
3328
|
+
# @option opts [Time] :created_at_lt A ISO-8601 date to filter results with a created date less than (before) the one provided.
|
3329
|
+
# @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')
|
3330
|
+
# @return [Array<(Array<WorkflowRun>, Integer, Hash)>] Array<WorkflowRun> data, response status code and response headers
|
3331
|
+
def list_workflow_runs_with_http_info(opts = {})
|
3332
|
+
if @api_client.config.debugging
|
3333
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.list_workflow_runs ...'
|
3334
|
+
end
|
3335
|
+
allowable_values = ["desc", "asc", "unknown_default_open_api"]
|
3336
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
3337
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
3338
|
+
end
|
3339
|
+
# resource path
|
3340
|
+
local_var_path = '/workflow_runs'
|
3341
|
+
|
3342
|
+
# query parameters
|
3343
|
+
query_params = opts[:query_params] || {}
|
3344
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
3345
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
3346
|
+
query_params[:'created_at_gt'] = opts[:'created_at_gt'] if !opts[:'created_at_gt'].nil?
|
3347
|
+
query_params[:'created_at_lt'] = opts[:'created_at_lt'] if !opts[:'created_at_lt'].nil?
|
3348
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
3349
|
+
|
3350
|
+
# header parameters
|
3351
|
+
header_params = opts[:header_params] || {}
|
3352
|
+
# HTTP header 'Accept' (if needed)
|
3353
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3354
|
+
|
3355
|
+
# form parameters
|
3356
|
+
form_params = opts[:form_params] || {}
|
3357
|
+
|
3358
|
+
# http body (model)
|
3359
|
+
post_body = opts[:debug_body]
|
3360
|
+
|
3361
|
+
# return_type
|
3362
|
+
return_type = opts[:debug_return_type] || 'Array<WorkflowRun>'
|
3363
|
+
|
3364
|
+
# auth_names
|
3365
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3366
|
+
|
3367
|
+
new_options = opts.merge(
|
3368
|
+
:operation => :"DefaultApi.list_workflow_runs",
|
3369
|
+
:header_params => header_params,
|
3370
|
+
:query_params => query_params,
|
3371
|
+
:form_params => form_params,
|
3372
|
+
:body => post_body,
|
3373
|
+
:auth_names => auth_names,
|
3374
|
+
:return_type => return_type
|
3375
|
+
)
|
3376
|
+
|
3377
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3378
|
+
if @api_client.config.debugging
|
3379
|
+
@api_client.config.logger.debug "API called: DefaultApi#list_workflow_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3380
|
+
end
|
3381
|
+
return data, status_code, headers
|
3382
|
+
end
|
3383
|
+
|
3384
|
+
# Ping
|
3385
|
+
# Run a health check on the Onfido API
|
3386
|
+
# @param [Hash] opts the optional parameters
|
3387
|
+
# @return [String]
|
3388
|
+
def ping(opts = {})
|
3389
|
+
data, _status_code, _headers = ping_with_http_info(opts)
|
3390
|
+
data
|
3391
|
+
end
|
3392
|
+
|
3393
|
+
# Ping
|
3394
|
+
# Run a health check on the Onfido API
|
3395
|
+
# @param [Hash] opts the optional parameters
|
3396
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
3397
|
+
def ping_with_http_info(opts = {})
|
3398
|
+
if @api_client.config.debugging
|
3399
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.ping ...'
|
3400
|
+
end
|
3401
|
+
# resource path
|
3402
|
+
local_var_path = '/ping'
|
3403
|
+
|
3404
|
+
# query parameters
|
3405
|
+
query_params = opts[:query_params] || {}
|
3406
|
+
|
3407
|
+
# header parameters
|
3408
|
+
header_params = opts[:header_params] || {}
|
3409
|
+
# HTTP header 'Accept' (if needed)
|
3410
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json'])
|
3411
|
+
|
3412
|
+
# form parameters
|
3413
|
+
form_params = opts[:form_params] || {}
|
3414
|
+
|
3415
|
+
# http body (model)
|
3416
|
+
post_body = opts[:debug_body]
|
3417
|
+
|
3418
|
+
# return_type
|
3419
|
+
return_type = opts[:debug_return_type] || 'String'
|
3420
|
+
|
3421
|
+
# auth_names
|
3422
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3423
|
+
|
3424
|
+
new_options = opts.merge(
|
3425
|
+
:operation => :"DefaultApi.ping",
|
3426
|
+
:header_params => header_params,
|
3427
|
+
:query_params => query_params,
|
3428
|
+
:form_params => form_params,
|
3429
|
+
:body => post_body,
|
3430
|
+
:auth_names => auth_names,
|
3431
|
+
:return_type => return_type
|
3432
|
+
)
|
3433
|
+
|
3434
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3435
|
+
if @api_client.config.debugging
|
3436
|
+
@api_client.config.logger.debug "API called: DefaultApi#ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3437
|
+
end
|
3438
|
+
return data, status_code, headers
|
3439
|
+
end
|
3440
|
+
|
3441
|
+
# Fraud reporting (ALPHA)
|
3442
|
+
# Create Feedback on checks and reports
|
3443
|
+
# @param results_feedback [ResultsFeedback]
|
3444
|
+
# @param [Hash] opts the optional parameters
|
3445
|
+
# @return [ResultsFeedback]
|
3446
|
+
def post_results_feedback(results_feedback, opts = {})
|
3447
|
+
data, _status_code, _headers = post_results_feedback_with_http_info(results_feedback, opts)
|
3448
|
+
data
|
3449
|
+
end
|
3450
|
+
|
3451
|
+
# Fraud reporting (ALPHA)
|
3452
|
+
# Create Feedback on checks and reports
|
3453
|
+
# @param results_feedback [ResultsFeedback]
|
3454
|
+
# @param [Hash] opts the optional parameters
|
3455
|
+
# @return [Array<(ResultsFeedback, Integer, Hash)>] ResultsFeedback data, response status code and response headers
|
3456
|
+
def post_results_feedback_with_http_info(results_feedback, opts = {})
|
3457
|
+
if @api_client.config.debugging
|
3458
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.post_results_feedback ...'
|
3459
|
+
end
|
3460
|
+
# verify the required parameter 'results_feedback' is set
|
3461
|
+
if @api_client.config.client_side_validation && results_feedback.nil?
|
3462
|
+
fail ArgumentError, "Missing the required parameter 'results_feedback' when calling DefaultApi.post_results_feedback"
|
3463
|
+
end
|
3464
|
+
# resource path
|
3465
|
+
local_var_path = '/results_feedback'
|
3466
|
+
|
3467
|
+
# query parameters
|
3468
|
+
query_params = opts[:query_params] || {}
|
3469
|
+
|
3470
|
+
# header parameters
|
3471
|
+
header_params = opts[:header_params] || {}
|
3472
|
+
# HTTP header 'Accept' (if needed)
|
3473
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3474
|
+
# HTTP header 'Content-Type'
|
3475
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3476
|
+
if !content_type.nil?
|
3477
|
+
header_params['Content-Type'] = content_type
|
3478
|
+
end
|
3479
|
+
|
3480
|
+
# form parameters
|
3481
|
+
form_params = opts[:form_params] || {}
|
3482
|
+
|
3483
|
+
# http body (model)
|
3484
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(results_feedback)
|
3485
|
+
|
3486
|
+
# return_type
|
3487
|
+
return_type = opts[:debug_return_type] || 'ResultsFeedback'
|
3488
|
+
|
3489
|
+
# auth_names
|
3490
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3491
|
+
|
3492
|
+
new_options = opts.merge(
|
3493
|
+
:operation => :"DefaultApi.post_results_feedback",
|
3494
|
+
:header_params => header_params,
|
3495
|
+
:query_params => query_params,
|
3496
|
+
:form_params => form_params,
|
3497
|
+
:body => post_body,
|
3498
|
+
:auth_names => auth_names,
|
3499
|
+
:return_type => return_type
|
3500
|
+
)
|
3501
|
+
|
3502
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3503
|
+
if @api_client.config.debugging
|
3504
|
+
@api_client.config.logger.debug "API called: DefaultApi#post_results_feedback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3505
|
+
end
|
3506
|
+
return data, status_code, headers
|
3507
|
+
end
|
3508
|
+
|
3509
|
+
# Resends webhooks
|
3510
|
+
# Resends events to all webhooks registered with a matching environment in your account.
|
3511
|
+
# @param webhook_resend [WebhookResend]
|
3512
|
+
# @param [Hash] opts the optional parameters
|
3513
|
+
# @return [nil]
|
3514
|
+
def resend_webhooks(webhook_resend, opts = {})
|
3515
|
+
resend_webhooks_with_http_info(webhook_resend, opts)
|
3516
|
+
nil
|
3517
|
+
end
|
3518
|
+
|
3519
|
+
# Resends webhooks
|
3520
|
+
# Resends events to all webhooks registered with a matching environment in your account.
|
3521
|
+
# @param webhook_resend [WebhookResend]
|
3522
|
+
# @param [Hash] opts the optional parameters
|
3523
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
3524
|
+
def resend_webhooks_with_http_info(webhook_resend, opts = {})
|
3525
|
+
if @api_client.config.debugging
|
3526
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.resend_webhooks ...'
|
3527
|
+
end
|
3528
|
+
# verify the required parameter 'webhook_resend' is set
|
3529
|
+
if @api_client.config.client_side_validation && webhook_resend.nil?
|
3530
|
+
fail ArgumentError, "Missing the required parameter 'webhook_resend' when calling DefaultApi.resend_webhooks"
|
3531
|
+
end
|
3532
|
+
# resource path
|
3533
|
+
local_var_path = '/webhooks/resend'
|
3534
|
+
|
3535
|
+
# query parameters
|
3536
|
+
query_params = opts[:query_params] || {}
|
3537
|
+
|
3538
|
+
# header parameters
|
3539
|
+
header_params = opts[:header_params] || {}
|
3540
|
+
# HTTP header 'Accept' (if needed)
|
3541
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3542
|
+
# HTTP header 'Content-Type'
|
3543
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3544
|
+
if !content_type.nil?
|
3545
|
+
header_params['Content-Type'] = content_type
|
3546
|
+
end
|
3547
|
+
|
3548
|
+
# form parameters
|
3549
|
+
form_params = opts[:form_params] || {}
|
3550
|
+
|
3551
|
+
# http body (model)
|
3552
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_resend)
|
3553
|
+
|
3554
|
+
# return_type
|
3555
|
+
return_type = opts[:debug_return_type]
|
3556
|
+
|
3557
|
+
# auth_names
|
3558
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3559
|
+
|
3560
|
+
new_options = opts.merge(
|
3561
|
+
:operation => :"DefaultApi.resend_webhooks",
|
3562
|
+
:header_params => header_params,
|
3563
|
+
:query_params => query_params,
|
3564
|
+
:form_params => form_params,
|
3565
|
+
:body => post_body,
|
3566
|
+
:auth_names => auth_names,
|
3567
|
+
:return_type => return_type
|
3568
|
+
)
|
3569
|
+
|
3570
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3571
|
+
if @api_client.config.debugging
|
3572
|
+
@api_client.config.logger.debug "API called: DefaultApi#resend_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3573
|
+
end
|
3574
|
+
return data, status_code, headers
|
3575
|
+
end
|
3576
|
+
|
3577
|
+
# Restore Applicant
|
3578
|
+
# Restores a single applicant scheduled for deletion.
|
3579
|
+
# @param applicant_id [String]
|
3580
|
+
# @param [Hash] opts the optional parameters
|
3581
|
+
# @return [nil]
|
3582
|
+
def restore_applicant(applicant_id, opts = {})
|
3583
|
+
restore_applicant_with_http_info(applicant_id, opts)
|
3584
|
+
nil
|
3585
|
+
end
|
3586
|
+
|
3587
|
+
# Restore Applicant
|
3588
|
+
# Restores a single applicant scheduled for deletion.
|
3589
|
+
# @param applicant_id [String]
|
3590
|
+
# @param [Hash] opts the optional parameters
|
3591
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
3592
|
+
def restore_applicant_with_http_info(applicant_id, opts = {})
|
3593
|
+
if @api_client.config.debugging
|
3594
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.restore_applicant ...'
|
3595
|
+
end
|
3596
|
+
# verify the required parameter 'applicant_id' is set
|
3597
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
3598
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.restore_applicant"
|
3599
|
+
end
|
3600
|
+
# resource path
|
3601
|
+
local_var_path = '/applicants/{applicant_id}/restore'.sub('{' + 'applicant_id' + '}', CGI.escape(applicant_id.to_s))
|
3602
|
+
|
3603
|
+
# query parameters
|
3604
|
+
query_params = opts[:query_params] || {}
|
3605
|
+
|
3606
|
+
# header parameters
|
3607
|
+
header_params = opts[:header_params] || {}
|
3608
|
+
# HTTP header 'Accept' (if needed)
|
3609
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3610
|
+
|
3611
|
+
# form parameters
|
3612
|
+
form_params = opts[:form_params] || {}
|
3613
|
+
|
3614
|
+
# http body (model)
|
3615
|
+
post_body = opts[:debug_body]
|
3616
|
+
|
3617
|
+
# return_type
|
3618
|
+
return_type = opts[:debug_return_type]
|
3619
|
+
|
3620
|
+
# auth_names
|
3621
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3622
|
+
|
3623
|
+
new_options = opts.merge(
|
3624
|
+
:operation => :"DefaultApi.restore_applicant",
|
3625
|
+
:header_params => header_params,
|
3626
|
+
:query_params => query_params,
|
3627
|
+
:form_params => form_params,
|
3628
|
+
:body => post_body,
|
3629
|
+
:auth_names => auth_names,
|
3630
|
+
:return_type => return_type
|
3631
|
+
)
|
3632
|
+
|
3633
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3634
|
+
if @api_client.config.debugging
|
3635
|
+
@api_client.config.logger.debug "API called: DefaultApi#restore_applicant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3636
|
+
end
|
3637
|
+
return data, status_code, headers
|
3638
|
+
end
|
3639
|
+
|
3640
|
+
# Resume a Check
|
3641
|
+
# Resumes a paused check.
|
3642
|
+
# @param check_id [String]
|
3643
|
+
# @param [Hash] opts the optional parameters
|
3644
|
+
# @return [nil]
|
3645
|
+
def resume_check(check_id, opts = {})
|
3646
|
+
resume_check_with_http_info(check_id, opts)
|
3647
|
+
nil
|
3648
|
+
end
|
3649
|
+
|
3650
|
+
# Resume a Check
|
3651
|
+
# Resumes a paused check.
|
3652
|
+
# @param check_id [String]
|
3653
|
+
# @param [Hash] opts the optional parameters
|
3654
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
3655
|
+
def resume_check_with_http_info(check_id, opts = {})
|
3656
|
+
if @api_client.config.debugging
|
3657
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.resume_check ...'
|
3658
|
+
end
|
3659
|
+
# verify the required parameter 'check_id' is set
|
3660
|
+
if @api_client.config.client_side_validation && check_id.nil?
|
3661
|
+
fail ArgumentError, "Missing the required parameter 'check_id' when calling DefaultApi.resume_check"
|
3662
|
+
end
|
3663
|
+
# resource path
|
3664
|
+
local_var_path = '/checks/{check_id}/resume'.sub('{' + 'check_id' + '}', CGI.escape(check_id.to_s))
|
3665
|
+
|
3666
|
+
# query parameters
|
3667
|
+
query_params = opts[:query_params] || {}
|
3668
|
+
|
3669
|
+
# header parameters
|
3670
|
+
header_params = opts[:header_params] || {}
|
3671
|
+
# HTTP header 'Accept' (if needed)
|
3672
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3673
|
+
|
3674
|
+
# form parameters
|
3675
|
+
form_params = opts[:form_params] || {}
|
3676
|
+
|
3677
|
+
# http body (model)
|
3678
|
+
post_body = opts[:debug_body]
|
3679
|
+
|
3680
|
+
# return_type
|
3681
|
+
return_type = opts[:debug_return_type]
|
3682
|
+
|
3683
|
+
# auth_names
|
3684
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3685
|
+
|
3686
|
+
new_options = opts.merge(
|
3687
|
+
:operation => :"DefaultApi.resume_check",
|
3688
|
+
:header_params => header_params,
|
3689
|
+
:query_params => query_params,
|
3690
|
+
:form_params => form_params,
|
3691
|
+
:body => post_body,
|
3692
|
+
:auth_names => auth_names,
|
3693
|
+
:return_type => return_type
|
3694
|
+
)
|
3695
|
+
|
3696
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3697
|
+
if @api_client.config.debugging
|
3698
|
+
@api_client.config.logger.debug "API called: DefaultApi#resume_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3699
|
+
end
|
3700
|
+
return data, status_code, headers
|
3701
|
+
end
|
3702
|
+
|
3703
|
+
# Resume report
|
3704
|
+
# Resumes a single paused report.
|
3705
|
+
# @param report_id [String]
|
3706
|
+
# @param [Hash] opts the optional parameters
|
3707
|
+
# @return [nil]
|
3708
|
+
def resume_report(report_id, opts = {})
|
3709
|
+
resume_report_with_http_info(report_id, opts)
|
3710
|
+
nil
|
3711
|
+
end
|
3712
|
+
|
3713
|
+
# Resume report
|
3714
|
+
# Resumes a single paused report.
|
3715
|
+
# @param report_id [String]
|
3716
|
+
# @param [Hash] opts the optional parameters
|
3717
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
3718
|
+
def resume_report_with_http_info(report_id, opts = {})
|
3719
|
+
if @api_client.config.debugging
|
3720
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.resume_report ...'
|
3721
|
+
end
|
3722
|
+
# verify the required parameter 'report_id' is set
|
3723
|
+
if @api_client.config.client_side_validation && report_id.nil?
|
3724
|
+
fail ArgumentError, "Missing the required parameter 'report_id' when calling DefaultApi.resume_report"
|
3725
|
+
end
|
3726
|
+
# resource path
|
3727
|
+
local_var_path = '/reports/{report_id}/resume'.sub('{' + 'report_id' + '}', CGI.escape(report_id.to_s))
|
3728
|
+
|
3729
|
+
# query parameters
|
3730
|
+
query_params = opts[:query_params] || {}
|
3731
|
+
|
3732
|
+
# header parameters
|
3733
|
+
header_params = opts[:header_params] || {}
|
3734
|
+
# HTTP header 'Accept' (if needed)
|
3735
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3736
|
+
|
3737
|
+
# form parameters
|
3738
|
+
form_params = opts[:form_params] || {}
|
3739
|
+
|
3740
|
+
# http body (model)
|
3741
|
+
post_body = opts[:debug_body]
|
3742
|
+
|
3743
|
+
# return_type
|
3744
|
+
return_type = opts[:debug_return_type]
|
3745
|
+
|
3746
|
+
# auth_names
|
3747
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3748
|
+
|
3749
|
+
new_options = opts.merge(
|
3750
|
+
:operation => :"DefaultApi.resume_report",
|
3751
|
+
:header_params => header_params,
|
3752
|
+
:query_params => query_params,
|
3753
|
+
:form_params => form_params,
|
3754
|
+
:body => post_body,
|
3755
|
+
:auth_names => auth_names,
|
3756
|
+
:return_type => return_type
|
3757
|
+
)
|
3758
|
+
|
3759
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3760
|
+
if @api_client.config.debugging
|
3761
|
+
@api_client.config.logger.debug "API called: DefaultApi#resume_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3762
|
+
end
|
3763
|
+
return data, status_code, headers
|
3764
|
+
end
|
3765
|
+
|
3766
|
+
# Update Applicant
|
3767
|
+
# Allows updating applicant's information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant
|
3768
|
+
# @param applicant_id [String]
|
3769
|
+
# @param applicant_updater [ApplicantUpdater]
|
3770
|
+
# @param [Hash] opts the optional parameters
|
3771
|
+
# @return [Applicant]
|
3772
|
+
def update_applicant(applicant_id, applicant_updater, opts = {})
|
3773
|
+
data, _status_code, _headers = update_applicant_with_http_info(applicant_id, applicant_updater, opts)
|
3774
|
+
data
|
3775
|
+
end
|
3776
|
+
|
3777
|
+
# Update Applicant
|
3778
|
+
# Allows updating applicant's information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant
|
3779
|
+
# @param applicant_id [String]
|
3780
|
+
# @param applicant_updater [ApplicantUpdater]
|
3781
|
+
# @param [Hash] opts the optional parameters
|
3782
|
+
# @return [Array<(Applicant, Integer, Hash)>] Applicant data, response status code and response headers
|
3783
|
+
def update_applicant_with_http_info(applicant_id, applicant_updater, opts = {})
|
3784
|
+
if @api_client.config.debugging
|
3785
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.update_applicant ...'
|
3786
|
+
end
|
3787
|
+
# verify the required parameter 'applicant_id' is set
|
3788
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
3789
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.update_applicant"
|
3790
|
+
end
|
3791
|
+
# verify the required parameter 'applicant_updater' is set
|
3792
|
+
if @api_client.config.client_side_validation && applicant_updater.nil?
|
3793
|
+
fail ArgumentError, "Missing the required parameter 'applicant_updater' when calling DefaultApi.update_applicant"
|
3794
|
+
end
|
3795
|
+
# resource path
|
3796
|
+
local_var_path = '/applicants/{applicant_id}'.sub('{' + 'applicant_id' + '}', CGI.escape(applicant_id.to_s))
|
3797
|
+
|
3798
|
+
# query parameters
|
3799
|
+
query_params = opts[:query_params] || {}
|
3800
|
+
|
3801
|
+
# header parameters
|
3802
|
+
header_params = opts[:header_params] || {}
|
3803
|
+
# HTTP header 'Accept' (if needed)
|
3804
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3805
|
+
# HTTP header 'Content-Type'
|
3806
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3807
|
+
if !content_type.nil?
|
3808
|
+
header_params['Content-Type'] = content_type
|
3809
|
+
end
|
3810
|
+
|
3811
|
+
# form parameters
|
3812
|
+
form_params = opts[:form_params] || {}
|
3813
|
+
|
3814
|
+
# http body (model)
|
3815
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(applicant_updater)
|
3816
|
+
|
3817
|
+
# return_type
|
3818
|
+
return_type = opts[:debug_return_type] || 'Applicant'
|
3819
|
+
|
3820
|
+
# auth_names
|
3821
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3822
|
+
|
3823
|
+
new_options = opts.merge(
|
3824
|
+
:operation => :"DefaultApi.update_applicant",
|
3825
|
+
:header_params => header_params,
|
3826
|
+
:query_params => query_params,
|
3827
|
+
:form_params => form_params,
|
3828
|
+
:body => post_body,
|
3829
|
+
:auth_names => auth_names,
|
3830
|
+
:return_type => return_type
|
3831
|
+
)
|
3832
|
+
|
3833
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
3834
|
+
if @api_client.config.debugging
|
3835
|
+
@api_client.config.logger.debug "API called: DefaultApi#update_applicant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3836
|
+
end
|
3837
|
+
return data, status_code, headers
|
3838
|
+
end
|
3839
|
+
|
3840
|
+
# Set match status (BETA)
|
3841
|
+
# Update the status of the given matches
|
3842
|
+
# @param monitor_id [String]
|
3843
|
+
# @param watchlist_monitor_matches_updater [WatchlistMonitorMatchesUpdater]
|
3844
|
+
# @param [Hash] opts the optional parameters
|
3845
|
+
# @return [WatchlistMonitorMatchesList]
|
3846
|
+
def update_watchlist_monitor_match(monitor_id, watchlist_monitor_matches_updater, opts = {})
|
3847
|
+
data, _status_code, _headers = update_watchlist_monitor_match_with_http_info(monitor_id, watchlist_monitor_matches_updater, opts)
|
3848
|
+
data
|
3849
|
+
end
|
3850
|
+
|
3851
|
+
# Set match status (BETA)
|
3852
|
+
# Update the status of the given matches
|
3853
|
+
# @param monitor_id [String]
|
3854
|
+
# @param watchlist_monitor_matches_updater [WatchlistMonitorMatchesUpdater]
|
3855
|
+
# @param [Hash] opts the optional parameters
|
3856
|
+
# @return [Array<(WatchlistMonitorMatchesList, Integer, Hash)>] WatchlistMonitorMatchesList data, response status code and response headers
|
3857
|
+
def update_watchlist_monitor_match_with_http_info(monitor_id, watchlist_monitor_matches_updater, opts = {})
|
3858
|
+
if @api_client.config.debugging
|
3859
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.update_watchlist_monitor_match ...'
|
3860
|
+
end
|
3861
|
+
# verify the required parameter 'monitor_id' is set
|
3862
|
+
if @api_client.config.client_side_validation && monitor_id.nil?
|
3863
|
+
fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DefaultApi.update_watchlist_monitor_match"
|
3864
|
+
end
|
3865
|
+
# verify the required parameter 'watchlist_monitor_matches_updater' is set
|
3866
|
+
if @api_client.config.client_side_validation && watchlist_monitor_matches_updater.nil?
|
3867
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_monitor_matches_updater' when calling DefaultApi.update_watchlist_monitor_match"
|
3868
|
+
end
|
3869
|
+
# resource path
|
3870
|
+
local_var_path = '/watchlist_monitors/{monitor_id}/matches'.sub('{' + 'monitor_id' + '}', CGI.escape(monitor_id.to_s))
|
3871
|
+
|
3872
|
+
# query parameters
|
3873
|
+
query_params = opts[:query_params] || {}
|
3874
|
+
|
3875
|
+
# header parameters
|
3876
|
+
header_params = opts[:header_params] || {}
|
3877
|
+
# HTTP header 'Accept' (if needed)
|
3878
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3879
|
+
# HTTP header 'Content-Type'
|
3880
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3881
|
+
if !content_type.nil?
|
3882
|
+
header_params['Content-Type'] = content_type
|
3883
|
+
end
|
3884
|
+
|
3885
|
+
# form parameters
|
3886
|
+
form_params = opts[:form_params] || {}
|
3887
|
+
|
3888
|
+
# http body (model)
|
3889
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_monitor_matches_updater)
|
3890
|
+
|
3891
|
+
# return_type
|
3892
|
+
return_type = opts[:debug_return_type] || 'WatchlistMonitorMatchesList'
|
3893
|
+
|
3894
|
+
# auth_names
|
3895
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3896
|
+
|
3897
|
+
new_options = opts.merge(
|
3898
|
+
:operation => :"DefaultApi.update_watchlist_monitor_match",
|
3899
|
+
:header_params => header_params,
|
3900
|
+
:query_params => query_params,
|
3901
|
+
:form_params => form_params,
|
3902
|
+
:body => post_body,
|
3903
|
+
:auth_names => auth_names,
|
3904
|
+
:return_type => return_type
|
3905
|
+
)
|
3906
|
+
|
3907
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
3908
|
+
if @api_client.config.debugging
|
3909
|
+
@api_client.config.logger.debug "API called: DefaultApi#update_watchlist_monitor_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3910
|
+
end
|
3911
|
+
return data, status_code, headers
|
3912
|
+
end
|
3913
|
+
|
3914
|
+
# Edit a webhook
|
3915
|
+
# Edits a webhook. Returns the updated webhook object.
|
3916
|
+
# @param webhook_id [String]
|
3917
|
+
# @param webhook_updater [WebhookUpdater]
|
3918
|
+
# @param [Hash] opts the optional parameters
|
3919
|
+
# @return [Webhook]
|
3920
|
+
def update_webhook(webhook_id, webhook_updater, opts = {})
|
3921
|
+
data, _status_code, _headers = update_webhook_with_http_info(webhook_id, webhook_updater, opts)
|
3922
|
+
data
|
3923
|
+
end
|
3924
|
+
|
3925
|
+
# Edit a webhook
|
3926
|
+
# Edits a webhook. Returns the updated webhook object.
|
3927
|
+
# @param webhook_id [String]
|
3928
|
+
# @param webhook_updater [WebhookUpdater]
|
3929
|
+
# @param [Hash] opts the optional parameters
|
3930
|
+
# @return [Array<(Webhook, Integer, Hash)>] Webhook data, response status code and response headers
|
3931
|
+
def update_webhook_with_http_info(webhook_id, webhook_updater, opts = {})
|
3932
|
+
if @api_client.config.debugging
|
3933
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.update_webhook ...'
|
3934
|
+
end
|
3935
|
+
# verify the required parameter 'webhook_id' is set
|
3936
|
+
if @api_client.config.client_side_validation && webhook_id.nil?
|
3937
|
+
fail ArgumentError, "Missing the required parameter 'webhook_id' when calling DefaultApi.update_webhook"
|
3938
|
+
end
|
3939
|
+
# verify the required parameter 'webhook_updater' is set
|
3940
|
+
if @api_client.config.client_side_validation && webhook_updater.nil?
|
3941
|
+
fail ArgumentError, "Missing the required parameter 'webhook_updater' when calling DefaultApi.update_webhook"
|
3942
|
+
end
|
3943
|
+
# resource path
|
3944
|
+
local_var_path = '/webhooks/{webhook_id}'.sub('{' + 'webhook_id' + '}', CGI.escape(webhook_id.to_s))
|
3945
|
+
|
3946
|
+
# query parameters
|
3947
|
+
query_params = opts[:query_params] || {}
|
3948
|
+
|
3949
|
+
# header parameters
|
3950
|
+
header_params = opts[:header_params] || {}
|
3951
|
+
# HTTP header 'Accept' (if needed)
|
3952
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3953
|
+
# HTTP header 'Content-Type'
|
3954
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3955
|
+
if !content_type.nil?
|
3956
|
+
header_params['Content-Type'] = content_type
|
3957
|
+
end
|
3958
|
+
|
3959
|
+
# form parameters
|
3960
|
+
form_params = opts[:form_params] || {}
|
3961
|
+
|
3962
|
+
# http body (model)
|
3963
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_updater)
|
3964
|
+
|
3965
|
+
# return_type
|
3966
|
+
return_type = opts[:debug_return_type] || 'Webhook'
|
3967
|
+
|
3968
|
+
# auth_names
|
3969
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
3970
|
+
|
3971
|
+
new_options = opts.merge(
|
3972
|
+
:operation => :"DefaultApi.update_webhook",
|
3973
|
+
:header_params => header_params,
|
3974
|
+
:query_params => query_params,
|
3975
|
+
:form_params => form_params,
|
3976
|
+
:body => post_body,
|
3977
|
+
:auth_names => auth_names,
|
3978
|
+
:return_type => return_type
|
3979
|
+
)
|
3980
|
+
|
3981
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
3982
|
+
if @api_client.config.debugging
|
3983
|
+
@api_client.config.logger.debug "API called: DefaultApi#update_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3984
|
+
end
|
3985
|
+
return data, status_code, headers
|
3986
|
+
end
|
3987
|
+
|
3988
|
+
# Upload a document
|
3989
|
+
# Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
|
3990
|
+
# @param type [String] The type of document
|
3991
|
+
# @param applicant_id [String] The ID of the applicant whose document is being uploaded.
|
3992
|
+
# @param file [File] The file to be uploaded.
|
3993
|
+
# @param [Hash] opts the optional parameters
|
3994
|
+
# @option opts [String] :file_type The file type of the uploaded file
|
3995
|
+
# @option opts [String] :side The side of the document, if applicable. The possible values are front and back
|
3996
|
+
# @option opts [CountryCodes] :issuing_country The issuing country of the document, a 3-letter ISO code.
|
3997
|
+
# @option opts [Boolean] :validate_image_quality Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
|
3998
|
+
# @option opts [LocationBuilder] :location
|
3999
|
+
# @return [Document]
|
4000
|
+
def upload_document(type, applicant_id, file, opts = {})
|
4001
|
+
data, _status_code, _headers = upload_document_with_http_info(type, applicant_id, file, opts)
|
4002
|
+
data
|
4003
|
+
end
|
4004
|
+
|
4005
|
+
# Upload a document
|
4006
|
+
# Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
|
4007
|
+
# @param type [String] The type of document
|
4008
|
+
# @param applicant_id [String] The ID of the applicant whose document is being uploaded.
|
4009
|
+
# @param file [File] The file to be uploaded.
|
4010
|
+
# @param [Hash] opts the optional parameters
|
4011
|
+
# @option opts [String] :file_type The file type of the uploaded file
|
4012
|
+
# @option opts [String] :side The side of the document, if applicable. The possible values are front and back
|
4013
|
+
# @option opts [CountryCodes] :issuing_country The issuing country of the document, a 3-letter ISO code.
|
4014
|
+
# @option opts [Boolean] :validate_image_quality Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
|
4015
|
+
# @option opts [LocationBuilder] :location
|
4016
|
+
# @return [Array<(Document, Integer, Hash)>] Document data, response status code and response headers
|
4017
|
+
def upload_document_with_http_info(type, applicant_id, file, opts = {})
|
4018
|
+
if @api_client.config.debugging
|
4019
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.upload_document ...'
|
4020
|
+
end
|
4021
|
+
# verify the required parameter 'type' is set
|
4022
|
+
if @api_client.config.client_side_validation && type.nil?
|
4023
|
+
fail ArgumentError, "Missing the required parameter 'type' when calling DefaultApi.upload_document"
|
4024
|
+
end
|
4025
|
+
# verify the required parameter 'applicant_id' is set
|
4026
|
+
if @api_client.config.client_side_validation && applicant_id.nil?
|
4027
|
+
fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.upload_document"
|
4028
|
+
end
|
4029
|
+
# verify the required parameter 'file' is set
|
4030
|
+
if @api_client.config.client_side_validation && file.nil?
|
4031
|
+
fail ArgumentError, "Missing the required parameter 'file' when calling DefaultApi.upload_document"
|
4032
|
+
end
|
4033
|
+
allowable_values = ["jpg", "png", "pdf", "unknown_default_open_api"]
|
4034
|
+
if @api_client.config.client_side_validation && opts[:'file_type'] && !allowable_values.include?(opts[:'file_type'])
|
4035
|
+
fail ArgumentError, "invalid value for \"file_type\", must be one of #{allowable_values}"
|
4036
|
+
end
|
4037
|
+
allowable_values = ["front", "back", "unknown_default_open_api"]
|
4038
|
+
if @api_client.config.client_side_validation && opts[:'side'] && !allowable_values.include?(opts[:'side'])
|
4039
|
+
fail ArgumentError, "invalid value for \"side\", must be one of #{allowable_values}"
|
4040
|
+
end
|
4041
|
+
# resource path
|
4042
|
+
local_var_path = '/documents'
|
4043
|
+
|
4044
|
+
# query parameters
|
4045
|
+
query_params = opts[:query_params] || {}
|
4046
|
+
|
4047
|
+
# header parameters
|
4048
|
+
header_params = opts[:header_params] || {}
|
4049
|
+
# HTTP header 'Accept' (if needed)
|
4050
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4051
|
+
# HTTP header 'Content-Type'
|
4052
|
+
content_type = @api_client.select_header_content_type(['multipart/form-data'])
|
4053
|
+
if !content_type.nil?
|
4054
|
+
header_params['Content-Type'] = content_type
|
4055
|
+
end
|
4056
|
+
|
4057
|
+
# form parameters
|
4058
|
+
form_params = opts[:form_params] || {}
|
4059
|
+
form_params['type'] = type
|
4060
|
+
form_params['applicant_id'] = applicant_id
|
4061
|
+
form_params['file'] = file
|
4062
|
+
form_params['file_type'] = opts[:'file_type'] if !opts[:'file_type'].nil?
|
4063
|
+
form_params['side'] = opts[:'side'] if !opts[:'side'].nil?
|
4064
|
+
form_params['issuing_country'] = opts[:'issuing_country'] if !opts[:'issuing_country'].nil?
|
4065
|
+
form_params['validate_image_quality'] = opts[:'validate_image_quality'] if !opts[:'validate_image_quality'].nil?
|
4066
|
+
form_params['location'] = opts[:'location'] if !opts[:'location'].nil?
|
4067
|
+
|
4068
|
+
# http body (model)
|
4069
|
+
post_body = opts[:debug_body]
|
4070
|
+
|
4071
|
+
# return_type
|
4072
|
+
return_type = opts[:debug_return_type] || 'Document'
|
4073
|
+
|
4074
|
+
# auth_names
|
4075
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
4076
|
+
|
4077
|
+
new_options = opts.merge(
|
4078
|
+
:operation => :"DefaultApi.upload_document",
|
4079
|
+
:header_params => header_params,
|
4080
|
+
:query_params => query_params,
|
4081
|
+
:form_params => form_params,
|
4082
|
+
:body => post_body,
|
4083
|
+
:auth_names => auth_names,
|
4084
|
+
:return_type => return_type
|
4085
|
+
)
|
4086
|
+
|
4087
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4088
|
+
if @api_client.config.debugging
|
4089
|
+
@api_client.config.logger.debug "API called: DefaultApi#upload_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4090
|
+
end
|
4091
|
+
return data, status_code, headers
|
4092
|
+
end
|
4093
|
+
|
4094
|
+
# Upload ID photo
|
4095
|
+
# You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
|
4096
|
+
# @param [Hash] opts the optional parameters
|
4097
|
+
# @option opts [String] :applicant_id The ID of the applicant whose ID photo is being uploaded.
|
4098
|
+
# @option opts [File] :file The file to be uploaded.
|
4099
|
+
# @return [IdPhoto]
|
4100
|
+
def upload_id_photo(opts = {})
|
4101
|
+
data, _status_code, _headers = upload_id_photo_with_http_info(opts)
|
4102
|
+
data
|
4103
|
+
end
|
4104
|
+
|
4105
|
+
# Upload ID photo
|
4106
|
+
# You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
|
4107
|
+
# @param [Hash] opts the optional parameters
|
4108
|
+
# @option opts [String] :applicant_id The ID of the applicant whose ID photo is being uploaded.
|
4109
|
+
# @option opts [File] :file The file to be uploaded.
|
4110
|
+
# @return [Array<(IdPhoto, Integer, Hash)>] IdPhoto data, response status code and response headers
|
4111
|
+
def upload_id_photo_with_http_info(opts = {})
|
4112
|
+
if @api_client.config.debugging
|
4113
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.upload_id_photo ...'
|
4114
|
+
end
|
4115
|
+
# resource path
|
4116
|
+
local_var_path = '/id_photos'
|
4117
|
+
|
4118
|
+
# query parameters
|
4119
|
+
query_params = opts[:query_params] || {}
|
4120
|
+
|
4121
|
+
# header parameters
|
4122
|
+
header_params = opts[:header_params] || {}
|
4123
|
+
# HTTP header 'Accept' (if needed)
|
4124
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4125
|
+
# HTTP header 'Content-Type'
|
4126
|
+
content_type = @api_client.select_header_content_type(['multipart/form-data'])
|
4127
|
+
if !content_type.nil?
|
4128
|
+
header_params['Content-Type'] = content_type
|
4129
|
+
end
|
4130
|
+
|
4131
|
+
# form parameters
|
4132
|
+
form_params = opts[:form_params] || {}
|
4133
|
+
form_params['applicant_id'] = opts[:'applicant_id'] if !opts[:'applicant_id'].nil?
|
4134
|
+
form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
|
4135
|
+
|
4136
|
+
# http body (model)
|
4137
|
+
post_body = opts[:debug_body]
|
4138
|
+
|
4139
|
+
# return_type
|
4140
|
+
return_type = opts[:debug_return_type] || 'IdPhoto'
|
4141
|
+
|
4142
|
+
# auth_names
|
4143
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
4144
|
+
|
4145
|
+
new_options = opts.merge(
|
4146
|
+
:operation => :"DefaultApi.upload_id_photo",
|
4147
|
+
:header_params => header_params,
|
4148
|
+
:query_params => query_params,
|
4149
|
+
:form_params => form_params,
|
4150
|
+
:body => post_body,
|
4151
|
+
:auth_names => auth_names,
|
4152
|
+
:return_type => return_type
|
4153
|
+
)
|
4154
|
+
|
4155
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4156
|
+
if @api_client.config.debugging
|
4157
|
+
@api_client.config.logger.debug "API called: DefaultApi#upload_id_photo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4158
|
+
end
|
4159
|
+
return data, status_code, headers
|
4160
|
+
end
|
4161
|
+
|
4162
|
+
# Upload live photo
|
4163
|
+
# You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
|
4164
|
+
# @param [Hash] opts the optional parameters
|
4165
|
+
# @option opts [String] :applicant_id The ID of the applicant whose live photo is being uploaded.
|
4166
|
+
# @option opts [File] :file The file to be uploaded.
|
4167
|
+
# @option opts [Boolean] :advanced_validation Validates that the live photo contains exactly one face. (default to true)
|
4168
|
+
# @return [LivePhoto]
|
4169
|
+
def upload_live_photo(opts = {})
|
4170
|
+
data, _status_code, _headers = upload_live_photo_with_http_info(opts)
|
4171
|
+
data
|
4172
|
+
end
|
4173
|
+
|
4174
|
+
# Upload live photo
|
4175
|
+
# You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
|
4176
|
+
# @param [Hash] opts the optional parameters
|
4177
|
+
# @option opts [String] :applicant_id The ID of the applicant whose live photo is being uploaded.
|
4178
|
+
# @option opts [File] :file The file to be uploaded.
|
4179
|
+
# @option opts [Boolean] :advanced_validation Validates that the live photo contains exactly one face. (default to true)
|
4180
|
+
# @return [Array<(LivePhoto, Integer, Hash)>] LivePhoto data, response status code and response headers
|
4181
|
+
def upload_live_photo_with_http_info(opts = {})
|
4182
|
+
if @api_client.config.debugging
|
4183
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.upload_live_photo ...'
|
4184
|
+
end
|
4185
|
+
# resource path
|
4186
|
+
local_var_path = '/live_photos'
|
4187
|
+
|
4188
|
+
# query parameters
|
4189
|
+
query_params = opts[:query_params] || {}
|
4190
|
+
|
4191
|
+
# header parameters
|
4192
|
+
header_params = opts[:header_params] || {}
|
4193
|
+
# HTTP header 'Accept' (if needed)
|
4194
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4195
|
+
# HTTP header 'Content-Type'
|
4196
|
+
content_type = @api_client.select_header_content_type(['multipart/form-data'])
|
4197
|
+
if !content_type.nil?
|
4198
|
+
header_params['Content-Type'] = content_type
|
4199
|
+
end
|
4200
|
+
|
4201
|
+
# form parameters
|
4202
|
+
form_params = opts[:form_params] || {}
|
4203
|
+
form_params['applicant_id'] = opts[:'applicant_id'] if !opts[:'applicant_id'].nil?
|
4204
|
+
form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
|
4205
|
+
form_params['advanced_validation'] = opts[:'advanced_validation'] if !opts[:'advanced_validation'].nil?
|
4206
|
+
|
4207
|
+
# http body (model)
|
4208
|
+
post_body = opts[:debug_body]
|
4209
|
+
|
4210
|
+
# return_type
|
4211
|
+
return_type = opts[:debug_return_type] || 'LivePhoto'
|
4212
|
+
|
4213
|
+
# auth_names
|
4214
|
+
auth_names = opts[:debug_auth_names] || ['Token']
|
4215
|
+
|
4216
|
+
new_options = opts.merge(
|
4217
|
+
:operation => :"DefaultApi.upload_live_photo",
|
4218
|
+
:header_params => header_params,
|
4219
|
+
:query_params => query_params,
|
4220
|
+
:form_params => form_params,
|
4221
|
+
:body => post_body,
|
4222
|
+
:auth_names => auth_names,
|
4223
|
+
:return_type => return_type
|
4224
|
+
)
|
4225
|
+
|
4226
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4227
|
+
if @api_client.config.debugging
|
4228
|
+
@api_client.config.logger.debug "API called: DefaultApi#upload_live_photo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4229
|
+
end
|
4230
|
+
return data, status_code, headers
|
4231
|
+
end
|
4232
|
+
end
|
4233
|
+
end
|